Open Banking API

ATM

atmsGet

Gets a list of all `ATM` objects.


/atms

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/atms"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.ATMApi;

import java.io.File;
import java.util.*;

public class ATMApiExample {

    public static void main(String[] args) {
        
        ATMApi apiInstance = new ATMApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            ATMResponse result = apiInstance.atmsGet(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ATMApi#atmsGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.ATMApi;

public class ATMApiExample {

    public static void main(String[] args) {
        ATMApi apiInstance = new ATMApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            ATMResponse result = apiInstance.atmsGet(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ATMApi#atmsGet");
            e.printStackTrace();
        }
    }
}
String *ifModifiedSince = ifModifiedSince_example; // Used for conditional request, to retrieve data only if modified since a given date (optional)
String *ifNoneMatch = ifNoneMatch_example; // Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

ATMApi *apiInstance = [[ATMApi alloc] init];

[apiInstance atmsGetWith:ifModifiedSince
    ifNoneMatch:ifNoneMatch
              completionHandler: ^(ATMResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');

var api = new OpenBankingApi.ATMApi()

var opts = { 
  'ifModifiedSince': ifModifiedSince_example, // {String} Used for conditional request, to retrieve data only if modified since a given date
  'ifNoneMatch': ifNoneMatch_example // {String} Used for conditional request, to retrieve data only if the given Etag value does not match
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.atmsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class atmsGetExample
    {
        public void main()
        {
            
            var apiInstance = new ATMApi();
            var ifModifiedSince = ifModifiedSince_example;  // String | Used for conditional request, to retrieve data only if modified since a given date (optional) 
            var ifNoneMatch = ifNoneMatch_example;  // String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional) 

            try
            {
                ATMResponse result = apiInstance.atmsGet(ifModifiedSince, ifNoneMatch);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ATMApi.atmsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ATMApi();
$ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
$ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match

try {
    $result = $api_instance->atmsGet($ifModifiedSince, $ifNoneMatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ATMApi->atmsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ATMApi;

my $api_instance = WWW::SwaggerClient::ATMApi->new();
my $ifModifiedSince = ifModifiedSince_example; # String | Used for conditional request, to retrieve data only if modified since a given date
my $ifNoneMatch = ifNoneMatch_example; # String | Used for conditional request, to retrieve data only if the given Etag value does not match

eval { 
    my $result = $api_instance->atmsGet(ifModifiedSince => $ifModifiedSince, ifNoneMatch => $ifNoneMatch);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ATMApi->atmsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ATMApi()
ifModifiedSince = ifModifiedSince_example # String | Used for conditional request, to retrieve data only if modified since a given date (optional)
ifNoneMatch = ifNoneMatch_example # String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

try: 
    api_response = api_instance.atms_get(ifModifiedSince=ifModifiedSince, ifNoneMatch=ifNoneMatch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ATMApi->atmsGet: %s\n" % e)

Parameters

Header parameters
Name Description
If-Modified-Since
String
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
String
Used for conditional request, to retrieve data only if the given Etag value does not match

Responses

Status: 200 - Successful response with a list of `ATM` data

Name Type Format Description
Cache-Control String Describes how long this response can be cached
Etag String A unique ID identifying whether this resource has changed
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 400 - You have sent a request which could not be understood.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 408 - Your client has failed to submit a request, and a timeout has occurred.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 429 - You have requested this resource too often. Slow down.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 500 - An error occurred on the server. No further information is available.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 503 - The service is temporarily unavailable.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: default - A standard error response.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

atmsHead

Gets header information on the current set of `ATM` data


/atms

Usage and SDK Samples

curl -X HEAD "https://localhost:8080/open-banking/v2.3/atms"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.ATMApi;

import java.io.File;
import java.util.*;

public class ATMApiExample {

    public static void main(String[] args) {
        
        ATMApi apiInstance = new ATMApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            Object result = apiInstance.atmsHead(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ATMApi#atmsHead");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.ATMApi;

public class ATMApiExample {

    public static void main(String[] args) {
        ATMApi apiInstance = new ATMApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            Object result = apiInstance.atmsHead(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ATMApi#atmsHead");
            e.printStackTrace();
        }
    }
}
String *ifModifiedSince = ifModifiedSince_example; // Used for conditional request, to retrieve data only if modified since a given date (optional)
String *ifNoneMatch = ifNoneMatch_example; // Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

ATMApi *apiInstance = [[ATMApi alloc] init];

[apiInstance atmsHeadWith:ifModifiedSince
    ifNoneMatch:ifNoneMatch
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');

var api = new OpenBankingApi.ATMApi()

var opts = { 
  'ifModifiedSince': ifModifiedSince_example, // {String} Used for conditional request, to retrieve data only if modified since a given date
  'ifNoneMatch': ifNoneMatch_example // {String} Used for conditional request, to retrieve data only if the given Etag value does not match
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.atmsHead(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class atmsHeadExample
    {
        public void main()
        {
            
            var apiInstance = new ATMApi();
            var ifModifiedSince = ifModifiedSince_example;  // String | Used for conditional request, to retrieve data only if modified since a given date (optional) 
            var ifNoneMatch = ifNoneMatch_example;  // String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional) 

            try
            {
                Object result = apiInstance.atmsHead(ifModifiedSince, ifNoneMatch);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ATMApi.atmsHead: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ATMApi();
$ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
$ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match

try {
    $result = $api_instance->atmsHead($ifModifiedSince, $ifNoneMatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ATMApi->atmsHead: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ATMApi;

my $api_instance = WWW::SwaggerClient::ATMApi->new();
my $ifModifiedSince = ifModifiedSince_example; # String | Used for conditional request, to retrieve data only if modified since a given date
my $ifNoneMatch = ifNoneMatch_example; # String | Used for conditional request, to retrieve data only if the given Etag value does not match

eval { 
    my $result = $api_instance->atmsHead(ifModifiedSince => $ifModifiedSince, ifNoneMatch => $ifNoneMatch);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ATMApi->atmsHead: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ATMApi()
ifModifiedSince = ifModifiedSince_example # String | Used for conditional request, to retrieve data only if modified since a given date (optional)
ifNoneMatch = ifNoneMatch_example # String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

try: 
    api_response = api_instance.atms_head(ifModifiedSince=ifModifiedSince, ifNoneMatch=ifNoneMatch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ATMApi->atmsHead: %s\n" % e)

Parameters

Header parameters
Name Description
If-Modified-Since
String
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
String
Used for conditional request, to retrieve data only if the given Etag value does not match

Responses

Status: default - No response


AccountAccess

createAccountAccessConsents

Create Account Access Consents


/account-access-consents

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/account-access-consents"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.AccountAccessApi;

import java.io.File;
import java.util.*;

public class AccountAccessApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        AccountAccessApi apiInstance = new AccountAccessApi();
        OBReadConsent1 oBReadConsent1Param = ; // OBReadConsent1 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadConsentResponse1 result = apiInstance.createAccountAccessConsents(oBReadConsent1Param, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAccessApi#createAccountAccessConsents");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.AccountAccessApi;

public class AccountAccessApiExample {

    public static void main(String[] args) {
        AccountAccessApi apiInstance = new AccountAccessApi();
        OBReadConsent1 oBReadConsent1Param = ; // OBReadConsent1 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadConsentResponse1 result = apiInstance.createAccountAccessConsents(oBReadConsent1Param, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAccessApi#createAccountAccessConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBReadConsent1 *oBReadConsent1Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

AccountAccessApi *apiInstance = [[AccountAccessApi alloc] init];

// Create Account Access Consents
[apiInstance createAccountAccessConsentsWith:oBReadConsent1Param
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadConsentResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.AccountAccessApi()

var oBReadConsent1Param = ; // {OBReadConsent1} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAccountAccessConsents(oBReadConsent1Param, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAccountAccessConsentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AccountAccessApi();
            var oBReadConsent1Param = new OBReadConsent1(); // OBReadConsent1 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create Account Access Consents
                OBReadConsentResponse1 result = apiInstance.createAccountAccessConsents(oBReadConsent1Param, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountAccessApi.createAccountAccessConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AccountAccessApi();
$oBReadConsent1Param = ; // OBReadConsent1 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createAccountAccessConsents($oBReadConsent1Param, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountAccessApi->createAccountAccessConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountAccessApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AccountAccessApi->new();
my $oBReadConsent1Param = WWW::SwaggerClient::Object::OBReadConsent1->new(); # OBReadConsent1 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createAccountAccessConsents(oBReadConsent1Param => $oBReadConsent1Param, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountAccessApi->createAccountAccessConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountAccessApi()
oBReadConsent1Param =  # OBReadConsent1 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create Account Access Consents
    api_response = api_instance.create_account_access_consents(oBReadConsent1Param, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountAccessApi->createAccountAccessConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
Body parameters
Name Description
oBReadConsent1Param *

Responses

Status: 201 - Account Access Consents Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

deleteAccountAccessConsentsConsentId

Delete Account Access Consents


/account-access-consents/{ConsentId}

Usage and SDK Samples

curl -X DELETE "https://localhost:8080/open-banking/v2.3/account-access-consents/{ConsentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.AccountAccessApi;

import java.io.File;
import java.util.*;

public class AccountAccessApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        AccountAccessApi apiInstance = new AccountAccessApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            apiInstance.deleteAccountAccessConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAccessApi#deleteAccountAccessConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.AccountAccessApi;

public class AccountAccessApiExample {

    public static void main(String[] args) {
        AccountAccessApi apiInstance = new AccountAccessApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            apiInstance.deleteAccountAccessConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAccessApi#deleteAccountAccessConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

AccountAccessApi *apiInstance = [[AccountAccessApi alloc] init];

// Delete Account Access Consents
[apiInstance deleteAccountAccessConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.AccountAccessApi()

var consentId = consentId_example; // {String} ConsentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAccountAccessConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAccountAccessConsentsConsentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AccountAccessApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Delete Account Access Consents
                apiInstance.deleteAccountAccessConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountAccessApi.deleteAccountAccessConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AccountAccessApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $api_instance->deleteAccountAccessConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
} catch (Exception $e) {
    echo 'Exception when calling AccountAccessApi->deleteAccountAccessConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountAccessApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AccountAccessApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    $api_instance->deleteAccountAccessConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
};
if ($@) {
    warn "Exception when calling AccountAccessApi->deleteAccountAccessConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountAccessApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Delete Account Access Consents
    api_instance.delete_account_access_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
except ApiException as e:
    print("Exception when calling AccountAccessApi->deleteAccountAccessConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 204 - Account Access Consents Deleted

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getAccountAccessConsentsConsentId

Get Account Access Consents


/account-access-consents/{ConsentId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/account-access-consents/{ConsentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.AccountAccessApi;

import java.io.File;
import java.util.*;

public class AccountAccessApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        AccountAccessApi apiInstance = new AccountAccessApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadConsentResponse1 result = apiInstance.getAccountAccessConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAccessApi#getAccountAccessConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.AccountAccessApi;

public class AccountAccessApiExample {

    public static void main(String[] args) {
        AccountAccessApi apiInstance = new AccountAccessApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadConsentResponse1 result = apiInstance.getAccountAccessConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAccessApi#getAccountAccessConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

AccountAccessApi *apiInstance = [[AccountAccessApi alloc] init];

// Get Account Access Consents
[apiInstance getAccountAccessConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadConsentResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.AccountAccessApi()

var consentId = consentId_example; // {String} ConsentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountAccessConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountAccessConsentsConsentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AccountAccessApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Account Access Consents
                OBReadConsentResponse1 result = apiInstance.getAccountAccessConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountAccessApi.getAccountAccessConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AccountAccessApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getAccountAccessConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountAccessApi->getAccountAccessConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountAccessApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AccountAccessApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getAccountAccessConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountAccessApi->getAccountAccessConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountAccessApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Account Access Consents
    api_response = api_instance.get_account_access_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountAccessApi->getAccountAccessConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Account Access Consents Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Accounts

getAccounts

Get Accounts


/accounts

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/accounts"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.AccountsApi;

import java.io.File;
import java.util.*;

public class AccountsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        AccountsApi apiInstance = new AccountsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadAccount4 result = apiInstance.getAccounts(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccounts");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadAccount4 result = apiInstance.getAccounts(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccounts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

AccountsApi *apiInstance = [[AccountsApi alloc] init];

// Get Accounts
[apiInstance getAccountsWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadAccount4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.AccountsApi()

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccounts(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AccountsApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Accounts
                OBReadAccount4 result = apiInstance.getAccounts(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.getAccounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AccountsApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getAccounts($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->getAccounts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getAccounts(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountsApi->getAccounts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountsApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Accounts
    api_response = api_instance.get_accounts(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->getAccounts: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Accounts Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getAccountsAccountId

Get Accounts


/accounts/{AccountId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/accounts/{AccountId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.AccountsApi;

import java.io.File;
import java.util.*;

public class AccountsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        AccountsApi apiInstance = new AccountsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadAccount4 result = apiInstance.getAccountsAccountId(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccountsAccountId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadAccount4 result = apiInstance.getAccountsAccountId(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccountsAccountId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

AccountsApi *apiInstance = [[AccountsApi alloc] init];

// Get Accounts
[apiInstance getAccountsAccountIdWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadAccount4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.AccountsApi()

var accountId = accountId_example; // {String} AccountId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountId(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AccountsApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Accounts
                OBReadAccount4 result = apiInstance.getAccountsAccountId(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.getAccountsAccountId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AccountsApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getAccountsAccountId($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->getAccountsAccountId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getAccountsAccountId(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountsApi->getAccountsAccountId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AccountsApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Accounts
    api_response = api_instance.get_accounts_account_id(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->getAccountsAccountId: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Accounts Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

AuthorisationServers

organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdDelete

Delete an Authorisation Server


/organisation/{OrganisationType}/{OrganisationId}/authorisation-server/{AuthorisationServerId}

Usage and SDK Samples

curl -X DELETE "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/authorisation-server/{AuthorisationServerId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.AuthorisationServersApi;

import java.io.File;
import java.util.*;

public class AuthorisationServersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
        OAuth OAuth2SecurityReadWriteOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadWriteOps");
        OAuth2SecurityReadWriteOps.setAccessToken("YOUR ACCESS TOKEN");

        AuthorisationServersApi apiInstance = new AuthorisationServersApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String authorisationServerId = authorisationServerId_example; // String | The authorisation server Id
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdDelete(organisationType, organisationId, authorisationServerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorisationServersApi#organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdDelete");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.AuthorisationServersApi;

public class AuthorisationServersApiExample {

    public static void main(String[] args) {
        AuthorisationServersApi apiInstance = new AuthorisationServersApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String authorisationServerId = authorisationServerId_example; // String | The authorisation server Id
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdDelete(organisationType, organisationId, authorisationServerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorisationServersApi#organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadWriteOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *authorisationServerId = authorisationServerId_example; // The authorisation server Id

AuthorisationServersApi *apiInstance = [[AuthorisationServersApi alloc] init];

// Delete an Authorisation Server
[apiInstance organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdDeleteWith:organisationType
    organisationId:organisationId
    authorisationServerId:authorisationServerId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
var OAuth2SecurityReadWriteOps = defaultClient.authentications['OAuth2SecurityReadWriteOps'];
OAuth2SecurityReadWriteOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.AuthorisationServersApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var authorisationServerId = authorisationServerId_example; // {String} The authorisation server Id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdDelete(organisationType, organisationId, authorisationServerId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdDeleteExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthorisationServersApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var authorisationServerId = authorisationServerId_example;  // String | The authorisation server Id

            try
            {
                // Delete an Authorisation Server
                apiInstance.organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdDelete(organisationType, organisationId, authorisationServerId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthorisationServersApi.organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AuthorisationServersApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$authorisationServerId = authorisationServerId_example; // String | The authorisation server Id

try {
    $api_instance->organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdDelete($organisationType, $organisationId, $authorisationServerId);
} catch (Exception $e) {
    echo 'Exception when calling AuthorisationServersApi->organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthorisationServersApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AuthorisationServersApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $authorisationServerId = authorisationServerId_example; # String | The authorisation server Id

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdDelete(organisationType => $organisationType, organisationId => $organisationId, authorisationServerId => $authorisationServerId);
};
if ($@) {
    warn "Exception when calling AuthorisationServersApi->organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AuthorisationServersApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
authorisationServerId = authorisationServerId_example # String | The authorisation server Id

try: 
    # Delete an Authorisation Server
    api_instance.organisation_organisation_type_organisation_id_authorisation_server_authorisation_server_id_delete(organisationType, organisationId, authorisationServerId)
except ApiException as e:
    print("Exception when calling AuthorisationServersApi->organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdDelete: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
AuthorisationServerId*
String
The authorisation server Id
Required

Responses

Status: 204 - No Content

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdGet

Get .well-known entity


/organisation/{OrganisationType}/{OrganisationId}/authorisation-server/{AuthorisationServerId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/authorisation-server/{AuthorisationServerId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.AuthorisationServersApi;

import java.io.File;
import java.util.*;

public class AuthorisationServersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
        OAuth OAuth2SecurityReadOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadOps");
        OAuth2SecurityReadOps.setAccessToken("YOUR ACCESS TOKEN");

        AuthorisationServersApi apiInstance = new AuthorisationServersApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String authorisationServerId = authorisationServerId_example; // String | The authorisation server Id
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdGet(organisationType, organisationId, authorisationServerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorisationServersApi#organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.AuthorisationServersApi;

public class AuthorisationServersApiExample {

    public static void main(String[] args) {
        AuthorisationServersApi apiInstance = new AuthorisationServersApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String authorisationServerId = authorisationServerId_example; // String | The authorisation server Id
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdGet(organisationType, organisationId, authorisationServerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorisationServersApi#organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *authorisationServerId = authorisationServerId_example; // The authorisation server Id

AuthorisationServersApi *apiInstance = [[AuthorisationServersApi alloc] init];

// Get .well-known entity
[apiInstance organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdGetWith:organisationType
    organisationId:organisationId
    authorisationServerId:authorisationServerId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
var OAuth2SecurityReadOps = defaultClient.authentications['OAuth2SecurityReadOps'];
OAuth2SecurityReadOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.AuthorisationServersApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var authorisationServerId = authorisationServerId_example; // {String} The authorisation server Id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdGet(organisationType, organisationId, authorisationServerId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthorisationServersApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var authorisationServerId = authorisationServerId_example;  // String | The authorisation server Id

            try
            {
                // Get .well-known entity
                apiInstance.organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdGet(organisationType, organisationId, authorisationServerId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthorisationServersApi.organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AuthorisationServersApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$authorisationServerId = authorisationServerId_example; // String | The authorisation server Id

try {
    $api_instance->organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdGet($organisationType, $organisationId, $authorisationServerId);
} catch (Exception $e) {
    echo 'Exception when calling AuthorisationServersApi->organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthorisationServersApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AuthorisationServersApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $authorisationServerId = authorisationServerId_example; # String | The authorisation server Id

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdGet(organisationType => $organisationType, organisationId => $organisationId, authorisationServerId => $authorisationServerId);
};
if ($@) {
    warn "Exception when calling AuthorisationServersApi->organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AuthorisationServersApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
authorisationServerId = authorisationServerId_example # String | The authorisation server Id

try: 
    # Get .well-known entity
    api_instance.organisation_organisation_type_organisation_id_authorisation_server_authorisation_server_id_get(organisationType, organisationId, authorisationServerId)
except ApiException as e:
    print("Exception when calling AuthorisationServersApi->organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
AuthorisationServerId*
String
The authorisation server Id
Required

Responses

Status: 200 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdPut

Update .well-known entity


/organisation/{OrganisationType}/{OrganisationId}/authorisation-server/{AuthorisationServerId}

Usage and SDK Samples

curl -X PUT "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/authorisation-server/{AuthorisationServerId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.AuthorisationServersApi;

import java.io.File;
import java.util.*;

public class AuthorisationServersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
        OAuth OAuth2SecurityReadWriteOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadWriteOps");
        OAuth2SecurityReadWriteOps.setAccessToken("YOUR ACCESS TOKEN");

        AuthorisationServersApi apiInstance = new AuthorisationServersApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String authorisationServerId = authorisationServerId_example; // String | The authorisation server Id
        AuthorisationServerRequestSchema authorisationServer = ; // AuthorisationServerRequestSchema | Properties to create/update authorisation server
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdPut(organisationType, organisationId, authorisationServerId, authorisationServer);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorisationServersApi#organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdPut");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.AuthorisationServersApi;

public class AuthorisationServersApiExample {

    public static void main(String[] args) {
        AuthorisationServersApi apiInstance = new AuthorisationServersApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String authorisationServerId = authorisationServerId_example; // String | The authorisation server Id
        AuthorisationServerRequestSchema authorisationServer = ; // AuthorisationServerRequestSchema | Properties to create/update authorisation server
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdPut(organisationType, organisationId, authorisationServerId, authorisationServer);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorisationServersApi#organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadWriteOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *authorisationServerId = authorisationServerId_example; // The authorisation server Id
AuthorisationServerRequestSchema *authorisationServer = ; // Properties to create/update authorisation server

AuthorisationServersApi *apiInstance = [[AuthorisationServersApi alloc] init];

// Update .well-known entity
[apiInstance organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdPutWith:organisationType
    organisationId:organisationId
    authorisationServerId:authorisationServerId
    authorisationServer:authorisationServer
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
var OAuth2SecurityReadWriteOps = defaultClient.authentications['OAuth2SecurityReadWriteOps'];
OAuth2SecurityReadWriteOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.AuthorisationServersApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var authorisationServerId = authorisationServerId_example; // {String} The authorisation server Id

var authorisationServer = ; // {AuthorisationServerRequestSchema} Properties to create/update authorisation server


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdPut(organisationType, organisationId, authorisationServerIdauthorisationServer, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdPutExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthorisationServersApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var authorisationServerId = authorisationServerId_example;  // String | The authorisation server Id
            var authorisationServer = new AuthorisationServerRequestSchema(); // AuthorisationServerRequestSchema | Properties to create/update authorisation server

            try
            {
                // Update .well-known entity
                apiInstance.organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdPut(organisationType, organisationId, authorisationServerId, authorisationServer);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthorisationServersApi.organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AuthorisationServersApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$authorisationServerId = authorisationServerId_example; // String | The authorisation server Id
$authorisationServer = ; // AuthorisationServerRequestSchema | Properties to create/update authorisation server

try {
    $api_instance->organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdPut($organisationType, $organisationId, $authorisationServerId, $authorisationServer);
} catch (Exception $e) {
    echo 'Exception when calling AuthorisationServersApi->organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthorisationServersApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AuthorisationServersApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $authorisationServerId = authorisationServerId_example; # String | The authorisation server Id
my $authorisationServer = WWW::SwaggerClient::Object::AuthorisationServerRequestSchema->new(); # AuthorisationServerRequestSchema | Properties to create/update authorisation server

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdPut(organisationType => $organisationType, organisationId => $organisationId, authorisationServerId => $authorisationServerId, authorisationServer => $authorisationServer);
};
if ($@) {
    warn "Exception when calling AuthorisationServersApi->organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdPut: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AuthorisationServersApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
authorisationServerId = authorisationServerId_example # String | The authorisation server Id
authorisationServer =  # AuthorisationServerRequestSchema | Properties to create/update authorisation server

try: 
    # Update .well-known entity
    api_instance.organisation_organisation_type_organisation_id_authorisation_server_authorisation_server_id_put(organisationType, organisationId, authorisationServerId, authorisationServer)
except ApiException as e:
    print("Exception when calling AuthorisationServersApi->organisationOrganisationTypeOrganisationIdAuthorisationServerAuthorisationServerIdPut: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
AuthorisationServerId*
String
The authorisation server Id
Required
Body parameters
Name Description
authorisationServer *

Responses

Status: 202 - Accepted

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypeOrganisationIdAuthorisationServerGet

Get all Authorisation Servers for the given organisation


/organisation/{OrganisationType}/{OrganisationId}/authorisation-server

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/authorisation-server"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.AuthorisationServersApi;

import java.io.File;
import java.util.*;

public class AuthorisationServersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
        OAuth OAuth2SecurityReadOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadOps");
        OAuth2SecurityReadOps.setAccessToken("YOUR ACCESS TOKEN");

        AuthorisationServersApi apiInstance = new AuthorisationServersApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdAuthorisationServerGet(organisationType, organisationId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorisationServersApi#organisationOrganisationTypeOrganisationIdAuthorisationServerGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.AuthorisationServersApi;

public class AuthorisationServersApiExample {

    public static void main(String[] args) {
        AuthorisationServersApi apiInstance = new AuthorisationServersApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdAuthorisationServerGet(organisationType, organisationId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorisationServersApi#organisationOrganisationTypeOrganisationIdAuthorisationServerGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID

AuthorisationServersApi *apiInstance = [[AuthorisationServersApi alloc] init];

// Get all Authorisation Servers for the given organisation
[apiInstance organisationOrganisationTypeOrganisationIdAuthorisationServerGetWith:organisationType
    organisationId:organisationId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
var OAuth2SecurityReadOps = defaultClient.authentications['OAuth2SecurityReadOps'];
OAuth2SecurityReadOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.AuthorisationServersApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdAuthorisationServerGet(organisationType, organisationId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdAuthorisationServerGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthorisationServersApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID

            try
            {
                // Get all Authorisation Servers for the given organisation
                apiInstance.organisationOrganisationTypeOrganisationIdAuthorisationServerGet(organisationType, organisationId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthorisationServersApi.organisationOrganisationTypeOrganisationIdAuthorisationServerGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AuthorisationServersApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID

try {
    $api_instance->organisationOrganisationTypeOrganisationIdAuthorisationServerGet($organisationType, $organisationId);
} catch (Exception $e) {
    echo 'Exception when calling AuthorisationServersApi->organisationOrganisationTypeOrganisationIdAuthorisationServerGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthorisationServersApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AuthorisationServersApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdAuthorisationServerGet(organisationType => $organisationType, organisationId => $organisationId);
};
if ($@) {
    warn "Exception when calling AuthorisationServersApi->organisationOrganisationTypeOrganisationIdAuthorisationServerGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AuthorisationServersApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID

try: 
    # Get all Authorisation Servers for the given organisation
    api_instance.organisation_organisation_type_organisation_id_authorisation_server_get(organisationType, organisationId)
except ApiException as e:
    print("Exception when calling AuthorisationServersApi->organisationOrganisationTypeOrganisationIdAuthorisationServerGet: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required

Responses

Status: 200 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypeOrganisationIdAuthorisationServerPost

Create an Authorisation Server for the given organisation


/organisation/{OrganisationType}/{OrganisationId}/authorisation-server

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/authorisation-server"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.AuthorisationServersApi;

import java.io.File;
import java.util.*;

public class AuthorisationServersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
        OAuth OAuth2SecurityReadWriteOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadWriteOps");
        OAuth2SecurityReadWriteOps.setAccessToken("YOUR ACCESS TOKEN");

        AuthorisationServersApi apiInstance = new AuthorisationServersApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        AuthorisationServerRequestSchema authorisationServer = ; // AuthorisationServerRequestSchema | Properties to create/update authorisation server
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdAuthorisationServerPost(organisationType, organisationId, authorisationServer);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorisationServersApi#organisationOrganisationTypeOrganisationIdAuthorisationServerPost");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.AuthorisationServersApi;

public class AuthorisationServersApiExample {

    public static void main(String[] args) {
        AuthorisationServersApi apiInstance = new AuthorisationServersApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        AuthorisationServerRequestSchema authorisationServer = ; // AuthorisationServerRequestSchema | Properties to create/update authorisation server
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdAuthorisationServerPost(organisationType, organisationId, authorisationServer);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorisationServersApi#organisationOrganisationTypeOrganisationIdAuthorisationServerPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadWriteOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
AuthorisationServerRequestSchema *authorisationServer = ; // Properties to create/update authorisation server

AuthorisationServersApi *apiInstance = [[AuthorisationServersApi alloc] init];

// Create an Authorisation Server for the given organisation
[apiInstance organisationOrganisationTypeOrganisationIdAuthorisationServerPostWith:organisationType
    organisationId:organisationId
    authorisationServer:authorisationServer
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
var OAuth2SecurityReadWriteOps = defaultClient.authentications['OAuth2SecurityReadWriteOps'];
OAuth2SecurityReadWriteOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.AuthorisationServersApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var authorisationServer = ; // {AuthorisationServerRequestSchema} Properties to create/update authorisation server


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdAuthorisationServerPost(organisationType, organisationId, authorisationServer, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdAuthorisationServerPostExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthorisationServersApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var authorisationServer = new AuthorisationServerRequestSchema(); // AuthorisationServerRequestSchema | Properties to create/update authorisation server

            try
            {
                // Create an Authorisation Server for the given organisation
                apiInstance.organisationOrganisationTypeOrganisationIdAuthorisationServerPost(organisationType, organisationId, authorisationServer);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthorisationServersApi.organisationOrganisationTypeOrganisationIdAuthorisationServerPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\AuthorisationServersApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$authorisationServer = ; // AuthorisationServerRequestSchema | Properties to create/update authorisation server

try {
    $api_instance->organisationOrganisationTypeOrganisationIdAuthorisationServerPost($organisationType, $organisationId, $authorisationServer);
} catch (Exception $e) {
    echo 'Exception when calling AuthorisationServersApi->organisationOrganisationTypeOrganisationIdAuthorisationServerPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthorisationServersApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AuthorisationServersApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $authorisationServer = WWW::SwaggerClient::Object::AuthorisationServerRequestSchema->new(); # AuthorisationServerRequestSchema | Properties to create/update authorisation server

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdAuthorisationServerPost(organisationType => $organisationType, organisationId => $organisationId, authorisationServer => $authorisationServer);
};
if ($@) {
    warn "Exception when calling AuthorisationServersApi->organisationOrganisationTypeOrganisationIdAuthorisationServerPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AuthorisationServersApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
authorisationServer =  # AuthorisationServerRequestSchema | Properties to create/update authorisation server

try: 
    # Create an Authorisation Server for the given organisation
    api_instance.organisation_organisation_type_organisation_id_authorisation_server_post(organisationType, organisationId, authorisationServer)
except ApiException as e:
    print("Exception when calling AuthorisationServersApi->organisationOrganisationTypeOrganisationIdAuthorisationServerPost: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
Body parameters
Name Description
authorisationServer *

Responses

Status: 201 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

BCA

businessCurrentAccountsGet

Gets a list of all `Branch Current Account` objects.


/business-current-accounts

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/business-current-accounts"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.BCAApi;

import java.io.File;
import java.util.*;

public class BCAApiExample {

    public static void main(String[] args) {
        
        BCAApi apiInstance = new BCAApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            BranchCurrentAccountResponse result = apiInstance.businessCurrentAccountsGet(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BCAApi#businessCurrentAccountsGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.BCAApi;

public class BCAApiExample {

    public static void main(String[] args) {
        BCAApi apiInstance = new BCAApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            BranchCurrentAccountResponse result = apiInstance.businessCurrentAccountsGet(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BCAApi#businessCurrentAccountsGet");
            e.printStackTrace();
        }
    }
}
String *ifModifiedSince = ifModifiedSince_example; // Used for conditional request, to retrieve data only if modified since a given date (optional)
String *ifNoneMatch = ifNoneMatch_example; // Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

BCAApi *apiInstance = [[BCAApi alloc] init];

[apiInstance businessCurrentAccountsGetWith:ifModifiedSince
    ifNoneMatch:ifNoneMatch
              completionHandler: ^(BranchCurrentAccountResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');

var api = new OpenBankingApi.BCAApi()

var opts = { 
  'ifModifiedSince': ifModifiedSince_example, // {String} Used for conditional request, to retrieve data only if modified since a given date
  'ifNoneMatch': ifNoneMatch_example // {String} Used for conditional request, to retrieve data only if the given Etag value does not match
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.businessCurrentAccountsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class businessCurrentAccountsGetExample
    {
        public void main()
        {
            
            var apiInstance = new BCAApi();
            var ifModifiedSince = ifModifiedSince_example;  // String | Used for conditional request, to retrieve data only if modified since a given date (optional) 
            var ifNoneMatch = ifNoneMatch_example;  // String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional) 

            try
            {
                BranchCurrentAccountResponse result = apiInstance.businessCurrentAccountsGet(ifModifiedSince, ifNoneMatch);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BCAApi.businessCurrentAccountsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BCAApi();
$ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
$ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match

try {
    $result = $api_instance->businessCurrentAccountsGet($ifModifiedSince, $ifNoneMatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BCAApi->businessCurrentAccountsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BCAApi;

my $api_instance = WWW::SwaggerClient::BCAApi->new();
my $ifModifiedSince = ifModifiedSince_example; # String | Used for conditional request, to retrieve data only if modified since a given date
my $ifNoneMatch = ifNoneMatch_example; # String | Used for conditional request, to retrieve data only if the given Etag value does not match

eval { 
    my $result = $api_instance->businessCurrentAccountsGet(ifModifiedSince => $ifModifiedSince, ifNoneMatch => $ifNoneMatch);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BCAApi->businessCurrentAccountsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BCAApi()
ifModifiedSince = ifModifiedSince_example # String | Used for conditional request, to retrieve data only if modified since a given date (optional)
ifNoneMatch = ifNoneMatch_example # String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

try: 
    api_response = api_instance.business_current_accounts_get(ifModifiedSince=ifModifiedSince, ifNoneMatch=ifNoneMatch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BCAApi->businessCurrentAccountsGet: %s\n" % e)

Parameters

Header parameters
Name Description
If-Modified-Since
String
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
String
Used for conditional request, to retrieve data only if the given Etag value does not match

Responses

Status: 200 - Successful response with a list of `Branch Current Account` data

Name Type Format Description
Cache-Control String Describes how long this response can be cached
Etag String A unique ID identifying whether this resource has changed
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 400 - You have sent a request which could not be understood.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 408 - Your client has failed to submit a request, and a timeout has occurred.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 429 - You have requested this resource too often. Slow down.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 500 - An error occurred on the server. No further information is available.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 503 - The service is temporarily unavailable.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: default - A standard error response.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

businessCurrentAccountsHead

Gets header information on the current set of `Business Current Account` data


/business-current-accounts

Usage and SDK Samples

curl -X HEAD "https://localhost:8080/open-banking/v2.3/business-current-accounts"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.BCAApi;

import java.io.File;
import java.util.*;

public class BCAApiExample {

    public static void main(String[] args) {
        
        BCAApi apiInstance = new BCAApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            Object result = apiInstance.businessCurrentAccountsHead(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BCAApi#businessCurrentAccountsHead");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.BCAApi;

public class BCAApiExample {

    public static void main(String[] args) {
        BCAApi apiInstance = new BCAApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            Object result = apiInstance.businessCurrentAccountsHead(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BCAApi#businessCurrentAccountsHead");
            e.printStackTrace();
        }
    }
}
String *ifModifiedSince = ifModifiedSince_example; // Used for conditional request, to retrieve data only if modified since a given date (optional)
String *ifNoneMatch = ifNoneMatch_example; // Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

BCAApi *apiInstance = [[BCAApi alloc] init];

[apiInstance businessCurrentAccountsHeadWith:ifModifiedSince
    ifNoneMatch:ifNoneMatch
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');

var api = new OpenBankingApi.BCAApi()

var opts = { 
  'ifModifiedSince': ifModifiedSince_example, // {String} Used for conditional request, to retrieve data only if modified since a given date
  'ifNoneMatch': ifNoneMatch_example // {String} Used for conditional request, to retrieve data only if the given Etag value does not match
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.businessCurrentAccountsHead(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class businessCurrentAccountsHeadExample
    {
        public void main()
        {
            
            var apiInstance = new BCAApi();
            var ifModifiedSince = ifModifiedSince_example;  // String | Used for conditional request, to retrieve data only if modified since a given date (optional) 
            var ifNoneMatch = ifNoneMatch_example;  // String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional) 

            try
            {
                Object result = apiInstance.businessCurrentAccountsHead(ifModifiedSince, ifNoneMatch);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BCAApi.businessCurrentAccountsHead: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BCAApi();
$ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
$ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match

try {
    $result = $api_instance->businessCurrentAccountsHead($ifModifiedSince, $ifNoneMatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BCAApi->businessCurrentAccountsHead: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BCAApi;

my $api_instance = WWW::SwaggerClient::BCAApi->new();
my $ifModifiedSince = ifModifiedSince_example; # String | Used for conditional request, to retrieve data only if modified since a given date
my $ifNoneMatch = ifNoneMatch_example; # String | Used for conditional request, to retrieve data only if the given Etag value does not match

eval { 
    my $result = $api_instance->businessCurrentAccountsHead(ifModifiedSince => $ifModifiedSince, ifNoneMatch => $ifNoneMatch);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BCAApi->businessCurrentAccountsHead: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BCAApi()
ifModifiedSince = ifModifiedSince_example # String | Used for conditional request, to retrieve data only if modified since a given date (optional)
ifNoneMatch = ifNoneMatch_example # String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

try: 
    api_response = api_instance.business_current_accounts_head(ifModifiedSince=ifModifiedSince, ifNoneMatch=ifNoneMatch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BCAApi->businessCurrentAccountsHead: %s\n" % e)

Parameters

Header parameters
Name Description
If-Modified-Since
String
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
String
Used for conditional request, to retrieve data only if the given Etag value does not match

Responses

Status: default - No response


Balances

getAccountsAccountIdBalances

Get Balances


/accounts/{AccountId}/balances

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/accounts/{AccountId}/balances"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.BalancesApi;

import java.io.File;
import java.util.*;

public class BalancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        BalancesApi apiInstance = new BalancesApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadBalance1 result = apiInstance.getAccountsAccountIdBalances(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BalancesApi#getAccountsAccountIdBalances");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.BalancesApi;

public class BalancesApiExample {

    public static void main(String[] args) {
        BalancesApi apiInstance = new BalancesApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadBalance1 result = apiInstance.getAccountsAccountIdBalances(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BalancesApi#getAccountsAccountIdBalances");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

BalancesApi *apiInstance = [[BalancesApi alloc] init];

// Get Balances
[apiInstance getAccountsAccountIdBalancesWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadBalance1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.BalancesApi()

var accountId = accountId_example; // {String} AccountId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdBalances(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdBalancesExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BalancesApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Balances
                OBReadBalance1 result = apiInstance.getAccountsAccountIdBalances(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BalancesApi.getAccountsAccountIdBalances: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\BalancesApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getAccountsAccountIdBalances($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BalancesApi->getAccountsAccountIdBalances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BalancesApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BalancesApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getAccountsAccountIdBalances(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BalancesApi->getAccountsAccountIdBalances: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BalancesApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Balances
    api_response = api_instance.get_accounts_account_id_balances(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalancesApi->getAccountsAccountIdBalances: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Balances Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getBalances

Get Balances


/balances

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/balances"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.BalancesApi;

import java.io.File;
import java.util.*;

public class BalancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        BalancesApi apiInstance = new BalancesApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadBalance1 result = apiInstance.getBalances(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BalancesApi#getBalances");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.BalancesApi;

public class BalancesApiExample {

    public static void main(String[] args) {
        BalancesApi apiInstance = new BalancesApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadBalance1 result = apiInstance.getBalances(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BalancesApi#getBalances");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

BalancesApi *apiInstance = [[BalancesApi alloc] init];

// Get Balances
[apiInstance getBalancesWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadBalance1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.BalancesApi()

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBalances(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBalancesExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BalancesApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Balances
                OBReadBalance1 result = apiInstance.getBalances(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BalancesApi.getBalances: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\BalancesApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getBalances($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BalancesApi->getBalances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BalancesApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BalancesApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getBalances(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BalancesApi->getBalances: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BalancesApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Balances
    api_response = api_instance.get_balances(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalancesApi->getBalances: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Balances Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Beneficiaries

getAccountsAccountIdBeneficiaries

Get Beneficiaries


/accounts/{AccountId}/beneficiaries

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/accounts/{AccountId}/beneficiaries"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.BeneficiariesApi;

import java.io.File;
import java.util.*;

public class BeneficiariesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        BeneficiariesApi apiInstance = new BeneficiariesApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadBeneficiary3 result = apiInstance.getAccountsAccountIdBeneficiaries(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BeneficiariesApi#getAccountsAccountIdBeneficiaries");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.BeneficiariesApi;

public class BeneficiariesApiExample {

    public static void main(String[] args) {
        BeneficiariesApi apiInstance = new BeneficiariesApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadBeneficiary3 result = apiInstance.getAccountsAccountIdBeneficiaries(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BeneficiariesApi#getAccountsAccountIdBeneficiaries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

BeneficiariesApi *apiInstance = [[BeneficiariesApi alloc] init];

// Get Beneficiaries
[apiInstance getAccountsAccountIdBeneficiariesWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadBeneficiary3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.BeneficiariesApi()

var accountId = accountId_example; // {String} AccountId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdBeneficiaries(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdBeneficiariesExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BeneficiariesApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Beneficiaries
                OBReadBeneficiary3 result = apiInstance.getAccountsAccountIdBeneficiaries(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BeneficiariesApi.getAccountsAccountIdBeneficiaries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\BeneficiariesApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getAccountsAccountIdBeneficiaries($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BeneficiariesApi->getAccountsAccountIdBeneficiaries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BeneficiariesApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BeneficiariesApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getAccountsAccountIdBeneficiaries(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BeneficiariesApi->getAccountsAccountIdBeneficiaries: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BeneficiariesApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Beneficiaries
    api_response = api_instance.get_accounts_account_id_beneficiaries(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BeneficiariesApi->getAccountsAccountIdBeneficiaries: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Beneficiaries Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getBeneficiaries

Get Beneficiaries


/beneficiaries

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/beneficiaries"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.BeneficiariesApi;

import java.io.File;
import java.util.*;

public class BeneficiariesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        BeneficiariesApi apiInstance = new BeneficiariesApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadBeneficiary3 result = apiInstance.getBeneficiaries(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BeneficiariesApi#getBeneficiaries");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.BeneficiariesApi;

public class BeneficiariesApiExample {

    public static void main(String[] args) {
        BeneficiariesApi apiInstance = new BeneficiariesApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadBeneficiary3 result = apiInstance.getBeneficiaries(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BeneficiariesApi#getBeneficiaries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

BeneficiariesApi *apiInstance = [[BeneficiariesApi alloc] init];

// Get Beneficiaries
[apiInstance getBeneficiariesWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadBeneficiary3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.BeneficiariesApi()

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBeneficiaries(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBeneficiariesExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BeneficiariesApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Beneficiaries
                OBReadBeneficiary3 result = apiInstance.getBeneficiaries(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BeneficiariesApi.getBeneficiaries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\BeneficiariesApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getBeneficiaries($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BeneficiariesApi->getBeneficiaries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BeneficiariesApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BeneficiariesApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getBeneficiaries(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BeneficiariesApi->getBeneficiaries: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BeneficiariesApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Beneficiaries
    api_response = api_instance.get_beneficiaries(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BeneficiariesApi->getBeneficiaries: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Beneficiaries Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Branch

branchesGet

Gets a list of all `Branch` objects.


/branches

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/branches"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.BranchApi;

import java.io.File;
import java.util.*;

public class BranchApiExample {

    public static void main(String[] args) {
        
        BranchApi apiInstance = new BranchApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            BranchResponse result = apiInstance.branchesGet(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BranchApi#branchesGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.BranchApi;

public class BranchApiExample {

    public static void main(String[] args) {
        BranchApi apiInstance = new BranchApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            BranchResponse result = apiInstance.branchesGet(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BranchApi#branchesGet");
            e.printStackTrace();
        }
    }
}
String *ifModifiedSince = ifModifiedSince_example; // Used for conditional request, to retrieve data only if modified since a given date (optional)
String *ifNoneMatch = ifNoneMatch_example; // Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

BranchApi *apiInstance = [[BranchApi alloc] init];

[apiInstance branchesGetWith:ifModifiedSince
    ifNoneMatch:ifNoneMatch
              completionHandler: ^(BranchResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');

var api = new OpenBankingApi.BranchApi()

var opts = { 
  'ifModifiedSince': ifModifiedSince_example, // {String} Used for conditional request, to retrieve data only if modified since a given date
  'ifNoneMatch': ifNoneMatch_example // {String} Used for conditional request, to retrieve data only if the given Etag value does not match
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.branchesGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class branchesGetExample
    {
        public void main()
        {
            
            var apiInstance = new BranchApi();
            var ifModifiedSince = ifModifiedSince_example;  // String | Used for conditional request, to retrieve data only if modified since a given date (optional) 
            var ifNoneMatch = ifNoneMatch_example;  // String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional) 

            try
            {
                BranchResponse result = apiInstance.branchesGet(ifModifiedSince, ifNoneMatch);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BranchApi.branchesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BranchApi();
$ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
$ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match

try {
    $result = $api_instance->branchesGet($ifModifiedSince, $ifNoneMatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BranchApi->branchesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BranchApi;

my $api_instance = WWW::SwaggerClient::BranchApi->new();
my $ifModifiedSince = ifModifiedSince_example; # String | Used for conditional request, to retrieve data only if modified since a given date
my $ifNoneMatch = ifNoneMatch_example; # String | Used for conditional request, to retrieve data only if the given Etag value does not match

eval { 
    my $result = $api_instance->branchesGet(ifModifiedSince => $ifModifiedSince, ifNoneMatch => $ifNoneMatch);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BranchApi->branchesGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BranchApi()
ifModifiedSince = ifModifiedSince_example # String | Used for conditional request, to retrieve data only if modified since a given date (optional)
ifNoneMatch = ifNoneMatch_example # String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

try: 
    api_response = api_instance.branches_get(ifModifiedSince=ifModifiedSince, ifNoneMatch=ifNoneMatch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BranchApi->branchesGet: %s\n" % e)

Parameters

Header parameters
Name Description
If-Modified-Since
String
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
String
Used for conditional request, to retrieve data only if the given Etag value does not match

Responses

Status: 200 - Successful response with a list of `Branch` data

Name Type Format Description
Cache-Control String Describes how long this response can be cached
Etag String A unique ID identifying whether this resource has changed
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 400 - You have sent a request which could not be understood.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 408 - Your client has failed to submit a request, and a timeout has occurred.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 429 - You have requested this resource too often. Slow down.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 500 - An error occurred on the server. No further information is available.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 503 - The service is temporarily unavailable.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: default - A standard error response.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

branchesHead

Gets header information on the current set of `Branch` data


/branches

Usage and SDK Samples

curl -X HEAD "https://localhost:8080/open-banking/v2.3/branches"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.BranchApi;

import java.io.File;
import java.util.*;

public class BranchApiExample {

    public static void main(String[] args) {
        
        BranchApi apiInstance = new BranchApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            Object result = apiInstance.branchesHead(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BranchApi#branchesHead");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.BranchApi;

public class BranchApiExample {

    public static void main(String[] args) {
        BranchApi apiInstance = new BranchApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            Object result = apiInstance.branchesHead(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BranchApi#branchesHead");
            e.printStackTrace();
        }
    }
}
String *ifModifiedSince = ifModifiedSince_example; // Used for conditional request, to retrieve data only if modified since a given date (optional)
String *ifNoneMatch = ifNoneMatch_example; // Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

BranchApi *apiInstance = [[BranchApi alloc] init];

[apiInstance branchesHeadWith:ifModifiedSince
    ifNoneMatch:ifNoneMatch
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');

var api = new OpenBankingApi.BranchApi()

var opts = { 
  'ifModifiedSince': ifModifiedSince_example, // {String} Used for conditional request, to retrieve data only if modified since a given date
  'ifNoneMatch': ifNoneMatch_example // {String} Used for conditional request, to retrieve data only if the given Etag value does not match
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.branchesHead(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class branchesHeadExample
    {
        public void main()
        {
            
            var apiInstance = new BranchApi();
            var ifModifiedSince = ifModifiedSince_example;  // String | Used for conditional request, to retrieve data only if modified since a given date (optional) 
            var ifNoneMatch = ifNoneMatch_example;  // String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional) 

            try
            {
                Object result = apiInstance.branchesHead(ifModifiedSince, ifNoneMatch);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BranchApi.branchesHead: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BranchApi();
$ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
$ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match

try {
    $result = $api_instance->branchesHead($ifModifiedSince, $ifNoneMatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BranchApi->branchesHead: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BranchApi;

my $api_instance = WWW::SwaggerClient::BranchApi->new();
my $ifModifiedSince = ifModifiedSince_example; # String | Used for conditional request, to retrieve data only if modified since a given date
my $ifNoneMatch = ifNoneMatch_example; # String | Used for conditional request, to retrieve data only if the given Etag value does not match

eval { 
    my $result = $api_instance->branchesHead(ifModifiedSince => $ifModifiedSince, ifNoneMatch => $ifNoneMatch);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BranchApi->branchesHead: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BranchApi()
ifModifiedSince = ifModifiedSince_example # String | Used for conditional request, to retrieve data only if modified since a given date (optional)
ifNoneMatch = ifNoneMatch_example # String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

try: 
    api_response = api_instance.branches_head(ifModifiedSince=ifModifiedSince, ifNoneMatch=ifNoneMatch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BranchApi->branchesHead: %s\n" % e)

Parameters

Header parameters
Name Description
If-Modified-Since
String
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
String
Used for conditional request, to retrieve data only if the given Etag value does not match

Responses

Status: default - No response


CCC

commercialCreditCardsGet

Gets a list of all `Commerical Credit Card` objects.


/commercial-credit-cards

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/commercial-credit-cards"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.CCCApi;

import java.io.File;
import java.util.*;

public class CCCApiExample {

    public static void main(String[] args) {
        
        CCCApi apiInstance = new CCCApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            CommercialCreditCardResponse result = apiInstance.commercialCreditCardsGet(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CCCApi#commercialCreditCardsGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.CCCApi;

public class CCCApiExample {

    public static void main(String[] args) {
        CCCApi apiInstance = new CCCApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            CommercialCreditCardResponse result = apiInstance.commercialCreditCardsGet(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CCCApi#commercialCreditCardsGet");
            e.printStackTrace();
        }
    }
}
String *ifModifiedSince = ifModifiedSince_example; // Used for conditional request, to retrieve data only if modified since a given date (optional)
String *ifNoneMatch = ifNoneMatch_example; // Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

CCCApi *apiInstance = [[CCCApi alloc] init];

[apiInstance commercialCreditCardsGetWith:ifModifiedSince
    ifNoneMatch:ifNoneMatch
              completionHandler: ^(CommercialCreditCardResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');

var api = new OpenBankingApi.CCCApi()

var opts = { 
  'ifModifiedSince': ifModifiedSince_example, // {String} Used for conditional request, to retrieve data only if modified since a given date
  'ifNoneMatch': ifNoneMatch_example // {String} Used for conditional request, to retrieve data only if the given Etag value does not match
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.commercialCreditCardsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class commercialCreditCardsGetExample
    {
        public void main()
        {
            
            var apiInstance = new CCCApi();
            var ifModifiedSince = ifModifiedSince_example;  // String | Used for conditional request, to retrieve data only if modified since a given date (optional) 
            var ifNoneMatch = ifNoneMatch_example;  // String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional) 

            try
            {
                CommercialCreditCardResponse result = apiInstance.commercialCreditCardsGet(ifModifiedSince, ifNoneMatch);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CCCApi.commercialCreditCardsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CCCApi();
$ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
$ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match

try {
    $result = $api_instance->commercialCreditCardsGet($ifModifiedSince, $ifNoneMatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CCCApi->commercialCreditCardsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CCCApi;

my $api_instance = WWW::SwaggerClient::CCCApi->new();
my $ifModifiedSince = ifModifiedSince_example; # String | Used for conditional request, to retrieve data only if modified since a given date
my $ifNoneMatch = ifNoneMatch_example; # String | Used for conditional request, to retrieve data only if the given Etag value does not match

eval { 
    my $result = $api_instance->commercialCreditCardsGet(ifModifiedSince => $ifModifiedSince, ifNoneMatch => $ifNoneMatch);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CCCApi->commercialCreditCardsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CCCApi()
ifModifiedSince = ifModifiedSince_example # String | Used for conditional request, to retrieve data only if modified since a given date (optional)
ifNoneMatch = ifNoneMatch_example # String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

try: 
    api_response = api_instance.commercial_credit_cards_get(ifModifiedSince=ifModifiedSince, ifNoneMatch=ifNoneMatch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CCCApi->commercialCreditCardsGet: %s\n" % e)

Parameters

Header parameters
Name Description
If-Modified-Since
String
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
String
Used for conditional request, to retrieve data only if the given Etag value does not match

Responses

Status: 200 - Successful response with a list of `Commercial Credit Card` data

Name Type Format Description
Cache-Control String Describes how long this response can be cached
Etag String A unique ID identifying whether this resource has changed
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 400 - You have sent a request which could not be understood.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 408 - Your client has failed to submit a request, and a timeout has occurred.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 429 - You have requested this resource too often. Slow down.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 500 - An error occurred on the server. No further information is available.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 503 - The service is temporarily unavailable.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: default - A standard error response.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

commercialCreditCardsHead

Gets header information on the current set of `Commerical Credit Card` data


/commercial-credit-cards

Usage and SDK Samples

curl -X HEAD "https://localhost:8080/open-banking/v2.3/commercial-credit-cards"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.CCCApi;

import java.io.File;
import java.util.*;

public class CCCApiExample {

    public static void main(String[] args) {
        
        CCCApi apiInstance = new CCCApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            Object result = apiInstance.commercialCreditCardsHead(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CCCApi#commercialCreditCardsHead");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.CCCApi;

public class CCCApiExample {

    public static void main(String[] args) {
        CCCApi apiInstance = new CCCApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            Object result = apiInstance.commercialCreditCardsHead(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CCCApi#commercialCreditCardsHead");
            e.printStackTrace();
        }
    }
}
String *ifModifiedSince = ifModifiedSince_example; // Used for conditional request, to retrieve data only if modified since a given date (optional)
String *ifNoneMatch = ifNoneMatch_example; // Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

CCCApi *apiInstance = [[CCCApi alloc] init];

[apiInstance commercialCreditCardsHeadWith:ifModifiedSince
    ifNoneMatch:ifNoneMatch
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');

var api = new OpenBankingApi.CCCApi()

var opts = { 
  'ifModifiedSince': ifModifiedSince_example, // {String} Used for conditional request, to retrieve data only if modified since a given date
  'ifNoneMatch': ifNoneMatch_example // {String} Used for conditional request, to retrieve data only if the given Etag value does not match
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.commercialCreditCardsHead(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class commercialCreditCardsHeadExample
    {
        public void main()
        {
            
            var apiInstance = new CCCApi();
            var ifModifiedSince = ifModifiedSince_example;  // String | Used for conditional request, to retrieve data only if modified since a given date (optional) 
            var ifNoneMatch = ifNoneMatch_example;  // String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional) 

            try
            {
                Object result = apiInstance.commercialCreditCardsHead(ifModifiedSince, ifNoneMatch);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CCCApi.commercialCreditCardsHead: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CCCApi();
$ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
$ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match

try {
    $result = $api_instance->commercialCreditCardsHead($ifModifiedSince, $ifNoneMatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CCCApi->commercialCreditCardsHead: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CCCApi;

my $api_instance = WWW::SwaggerClient::CCCApi->new();
my $ifModifiedSince = ifModifiedSince_example; # String | Used for conditional request, to retrieve data only if modified since a given date
my $ifNoneMatch = ifNoneMatch_example; # String | Used for conditional request, to retrieve data only if the given Etag value does not match

eval { 
    my $result = $api_instance->commercialCreditCardsHead(ifModifiedSince => $ifModifiedSince, ifNoneMatch => $ifNoneMatch);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CCCApi->commercialCreditCardsHead: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CCCApi()
ifModifiedSince = ifModifiedSince_example # String | Used for conditional request, to retrieve data only if modified since a given date (optional)
ifNoneMatch = ifNoneMatch_example # String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

try: 
    api_response = api_instance.commercial_credit_cards_head(ifModifiedSince=ifModifiedSince, ifNoneMatch=ifNoneMatch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CCCApi->commercialCreditCardsHead: %s\n" % e)

Parameters

Header parameters
Name Description
If-Modified-Since
String
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
String
Used for conditional request, to retrieve data only if the given Etag value does not match

Responses

Status: default - No response


CallbackURLs

callbackUrlsCallbackUrlIdDelete

Delete a callback URI


/callback-urls/{CallbackUrlId}

Usage and SDK Samples

curl -X DELETE "https://localhost:8080/open-banking/v2.3/callback-urls/{CallbackUrlId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.CallbackURLsApi;

import java.io.File;
import java.util.*;

public class CallbackURLsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        CallbackURLsApi apiInstance = new CallbackURLsApi();
        String callbackUrlId = callbackUrlId_example; // String | CallbackUrlId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            apiInstance.callbackUrlsCallbackUrlIdDelete(callbackUrlId, authorization, xFapiInteractionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallbackURLsApi#callbackUrlsCallbackUrlIdDelete");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.CallbackURLsApi;

public class CallbackURLsApiExample {

    public static void main(String[] args) {
        CallbackURLsApi apiInstance = new CallbackURLsApi();
        String callbackUrlId = callbackUrlId_example; // String | CallbackUrlId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            apiInstance.callbackUrlsCallbackUrlIdDelete(callbackUrlId, authorization, xFapiInteractionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallbackURLsApi#callbackUrlsCallbackUrlIdDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *callbackUrlId = callbackUrlId_example; // CallbackUrlId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

CallbackURLsApi *apiInstance = [[CallbackURLsApi alloc] init];

// Delete a callback URI
[apiInstance callbackUrlsCallbackUrlIdDeleteWith:callbackUrlId
    authorization:authorization
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.CallbackURLsApi()

var callbackUrlId = callbackUrlId_example; // {String} CallbackUrlId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiInteractionId': xFapiInteractionId_example // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.callbackUrlsCallbackUrlIdDelete(callbackUrlId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class callbackUrlsCallbackUrlIdDeleteExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CallbackURLsApi();
            var callbackUrlId = callbackUrlId_example;  // String | CallbackUrlId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Delete a callback URI
                apiInstance.callbackUrlsCallbackUrlIdDelete(callbackUrlId, authorization, xFapiInteractionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallbackURLsApi.callbackUrlsCallbackUrlIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\CallbackURLsApi();
$callbackUrlId = callbackUrlId_example; // String | CallbackUrlId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $api_instance->callbackUrlsCallbackUrlIdDelete($callbackUrlId, $authorization, $xFapiInteractionId);
} catch (Exception $e) {
    echo 'Exception when calling CallbackURLsApi->callbackUrlsCallbackUrlIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallbackURLsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CallbackURLsApi->new();
my $callbackUrlId = callbackUrlId_example; # String | CallbackUrlId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    $api_instance->callbackUrlsCallbackUrlIdDelete(callbackUrlId => $callbackUrlId, authorization => $authorization, xFapiInteractionId => $xFapiInteractionId);
};
if ($@) {
    warn "Exception when calling CallbackURLsApi->callbackUrlsCallbackUrlIdDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CallbackURLsApi()
callbackUrlId = callbackUrlId_example # String | CallbackUrlId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Delete a callback URI
    api_instance.callback_urls_callback_url_id_delete(callbackUrlId, authorization, xFapiInteractionId=xFapiInteractionId)
except ApiException as e:
    print("Exception when calling CallbackURLsApi->callbackUrlsCallbackUrlIdDelete: %s\n" % e)

Parameters

Path parameters
Name Description
CallbackUrlId*
String
CallbackUrlId
Required
Header parameters
Name Description
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 204 - Callback URL changed

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait

Status: 500 - Internal Server Error


callbackUrlsCallbackUrlIdPut

Amend a callback URI


/callback-urls/{CallbackUrlId}

Usage and SDK Samples

curl -X PUT "https://localhost:8080/open-banking/v2.3/callback-urls/{CallbackUrlId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.CallbackURLsApi;

import java.io.File;
import java.util.*;

public class CallbackURLsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        CallbackURLsApi apiInstance = new CallbackURLsApi();
        String callbackUrlId = callbackUrlId_example; // String | CallbackUrlId
        OBCallbackUrl1 oBCallbackUrl1Param = ; // OBCallbackUrl1 | Create an Callback URI
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xJwsSignature = xJwsSignature_example; // String | Header containing a detached JWS signature of the body of the payload.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBCallbackUrlResponse1 result = apiInstance.callbackUrlsCallbackUrlIdPut(callbackUrlId, oBCallbackUrl1Param, authorization, xJwsSignature, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallbackURLsApi#callbackUrlsCallbackUrlIdPut");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.CallbackURLsApi;

public class CallbackURLsApiExample {

    public static void main(String[] args) {
        CallbackURLsApi apiInstance = new CallbackURLsApi();
        String callbackUrlId = callbackUrlId_example; // String | CallbackUrlId
        OBCallbackUrl1 oBCallbackUrl1Param = ; // OBCallbackUrl1 | Create an Callback URI
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xJwsSignature = xJwsSignature_example; // String | Header containing a detached JWS signature of the body of the payload.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBCallbackUrlResponse1 result = apiInstance.callbackUrlsCallbackUrlIdPut(callbackUrlId, oBCallbackUrl1Param, authorization, xJwsSignature, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallbackURLsApi#callbackUrlsCallbackUrlIdPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *callbackUrlId = callbackUrlId_example; // CallbackUrlId
OBCallbackUrl1 *oBCallbackUrl1Param = ; // Create an Callback URI
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xJwsSignature = xJwsSignature_example; // Header containing a detached JWS signature of the body of the payload.
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

CallbackURLsApi *apiInstance = [[CallbackURLsApi alloc] init];

// Amend a callback URI
[apiInstance callbackUrlsCallbackUrlIdPutWith:callbackUrlId
    oBCallbackUrl1Param:oBCallbackUrl1Param
    authorization:authorization
    xJwsSignature:xJwsSignature
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBCallbackUrlResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.CallbackURLsApi()

var callbackUrlId = callbackUrlId_example; // {String} CallbackUrlId

var oBCallbackUrl1Param = ; // {OBCallbackUrl1} Create an Callback URI

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xJwsSignature = xJwsSignature_example; // {String} Header containing a detached JWS signature of the body of the payload.

var opts = { 
  'xFapiInteractionId': xFapiInteractionId_example // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.callbackUrlsCallbackUrlIdPut(callbackUrlId, oBCallbackUrl1Param, authorizationxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class callbackUrlsCallbackUrlIdPutExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CallbackURLsApi();
            var callbackUrlId = callbackUrlId_example;  // String | CallbackUrlId
            var oBCallbackUrl1Param = new OBCallbackUrl1(); // OBCallbackUrl1 | Create an Callback URI
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xJwsSignature = xJwsSignature_example;  // String | Header containing a detached JWS signature of the body of the payload.
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Amend a callback URI
                OBCallbackUrlResponse1 result = apiInstance.callbackUrlsCallbackUrlIdPut(callbackUrlId, oBCallbackUrl1Param, authorization, xJwsSignature, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallbackURLsApi.callbackUrlsCallbackUrlIdPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\CallbackURLsApi();
$callbackUrlId = callbackUrlId_example; // String | CallbackUrlId
$oBCallbackUrl1Param = ; // OBCallbackUrl1 | Create an Callback URI
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xJwsSignature = xJwsSignature_example; // String | Header containing a detached JWS signature of the body of the payload.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->callbackUrlsCallbackUrlIdPut($callbackUrlId, $oBCallbackUrl1Param, $authorization, $xJwsSignature, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CallbackURLsApi->callbackUrlsCallbackUrlIdPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallbackURLsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CallbackURLsApi->new();
my $callbackUrlId = callbackUrlId_example; # String | CallbackUrlId
my $oBCallbackUrl1Param = WWW::SwaggerClient::Object::OBCallbackUrl1->new(); # OBCallbackUrl1 | Create an Callback URI
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xJwsSignature = xJwsSignature_example; # String | Header containing a detached JWS signature of the body of the payload.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->callbackUrlsCallbackUrlIdPut(callbackUrlId => $callbackUrlId, oBCallbackUrl1Param => $oBCallbackUrl1Param, authorization => $authorization, xJwsSignature => $xJwsSignature, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CallbackURLsApi->callbackUrlsCallbackUrlIdPut: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CallbackURLsApi()
callbackUrlId = callbackUrlId_example # String | CallbackUrlId
oBCallbackUrl1Param =  # OBCallbackUrl1 | Create an Callback URI
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xJwsSignature = xJwsSignature_example # String | Header containing a detached JWS signature of the body of the payload.
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Amend a callback URI
    api_response = api_instance.callback_urls_callback_url_id_put(callbackUrlId, oBCallbackUrl1Param, authorization, xJwsSignature, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallbackURLsApi->callbackUrlsCallbackUrlIdPut: %s\n" % e)

Parameters

Path parameters
Name Description
CallbackUrlId*
String
CallbackUrlId
Required
Header parameters
Name Description
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-jws-signature*
String
Header containing a detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBCallbackUrl1Param *

Responses

Status: 200 - Callback URL changed

Name Type Format Description
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 415 - Unsupported Media Type

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait

Status: 500 - Internal Server Error


callbackUrlsGet

Read all callback URLs


/callback-urls

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/callback-urls"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.CallbackURLsApi;

import java.io.File;
import java.util.*;

public class CallbackURLsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        CallbackURLsApi apiInstance = new CallbackURLsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBCallbackUrlsResponse1 result = apiInstance.callbackUrlsGet(authorization, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallbackURLsApi#callbackUrlsGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.CallbackURLsApi;

public class CallbackURLsApiExample {

    public static void main(String[] args) {
        CallbackURLsApi apiInstance = new CallbackURLsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBCallbackUrlsResponse1 result = apiInstance.callbackUrlsGet(authorization, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallbackURLsApi#callbackUrlsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

CallbackURLsApi *apiInstance = [[CallbackURLsApi alloc] init];

// Read all callback URLs
[apiInstance callbackUrlsGetWith:authorization
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBCallbackUrlsResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.CallbackURLsApi()

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiInteractionId': xFapiInteractionId_example // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.callbackUrlsGet(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class callbackUrlsGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CallbackURLsApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Read all callback URLs
                OBCallbackUrlsResponse1 result = apiInstance.callbackUrlsGet(authorization, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallbackURLsApi.callbackUrlsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\CallbackURLsApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->callbackUrlsGet($authorization, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CallbackURLsApi->callbackUrlsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallbackURLsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CallbackURLsApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->callbackUrlsGet(authorization => $authorization, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CallbackURLsApi->callbackUrlsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CallbackURLsApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Read all callback URLs
    api_response = api_instance.callback_urls_get(authorization, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallbackURLsApi->callbackUrlsGet: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - An array of callback URLs

Name Type Format Description
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait

Status: 500 - Internal Server Error


callbackUrlsPost

Create a callback URL


/callback-urls

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/callback-urls"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.CallbackURLsApi;

import java.io.File;
import java.util.*;

public class CallbackURLsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        CallbackURLsApi apiInstance = new CallbackURLsApi();
        OBCallbackUrl1 oBCallbackUrl1Param = ; // OBCallbackUrl1 | Create an Callback URI
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xJwsSignature = xJwsSignature_example; // String | Header containing a detached JWS signature of the body of the payload.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBCallbackUrlResponse1 result = apiInstance.callbackUrlsPost(oBCallbackUrl1Param, authorization, xJwsSignature, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallbackURLsApi#callbackUrlsPost");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.CallbackURLsApi;

public class CallbackURLsApiExample {

    public static void main(String[] args) {
        CallbackURLsApi apiInstance = new CallbackURLsApi();
        OBCallbackUrl1 oBCallbackUrl1Param = ; // OBCallbackUrl1 | Create an Callback URI
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xJwsSignature = xJwsSignature_example; // String | Header containing a detached JWS signature of the body of the payload.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBCallbackUrlResponse1 result = apiInstance.callbackUrlsPost(oBCallbackUrl1Param, authorization, xJwsSignature, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallbackURLsApi#callbackUrlsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBCallbackUrl1 *oBCallbackUrl1Param = ; // Create an Callback URI
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xJwsSignature = xJwsSignature_example; // Header containing a detached JWS signature of the body of the payload.
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

CallbackURLsApi *apiInstance = [[CallbackURLsApi alloc] init];

// Create a callback URL
[apiInstance callbackUrlsPostWith:oBCallbackUrl1Param
    authorization:authorization
    xJwsSignature:xJwsSignature
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBCallbackUrlResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.CallbackURLsApi()

var oBCallbackUrl1Param = ; // {OBCallbackUrl1} Create an Callback URI

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xJwsSignature = xJwsSignature_example; // {String} Header containing a detached JWS signature of the body of the payload.

var opts = { 
  'xFapiInteractionId': xFapiInteractionId_example // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.callbackUrlsPost(oBCallbackUrl1Param, authorizationxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class callbackUrlsPostExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CallbackURLsApi();
            var oBCallbackUrl1Param = new OBCallbackUrl1(); // OBCallbackUrl1 | Create an Callback URI
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xJwsSignature = xJwsSignature_example;  // String | Header containing a detached JWS signature of the body of the payload.
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create a callback URL
                OBCallbackUrlResponse1 result = apiInstance.callbackUrlsPost(oBCallbackUrl1Param, authorization, xJwsSignature, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallbackURLsApi.callbackUrlsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\CallbackURLsApi();
$oBCallbackUrl1Param = ; // OBCallbackUrl1 | Create an Callback URI
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xJwsSignature = xJwsSignature_example; // String | Header containing a detached JWS signature of the body of the payload.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->callbackUrlsPost($oBCallbackUrl1Param, $authorization, $xJwsSignature, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CallbackURLsApi->callbackUrlsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallbackURLsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CallbackURLsApi->new();
my $oBCallbackUrl1Param = WWW::SwaggerClient::Object::OBCallbackUrl1->new(); # OBCallbackUrl1 | Create an Callback URI
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xJwsSignature = xJwsSignature_example; # String | Header containing a detached JWS signature of the body of the payload.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->callbackUrlsPost(oBCallbackUrl1Param => $oBCallbackUrl1Param, authorization => $authorization, xJwsSignature => $xJwsSignature, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CallbackURLsApi->callbackUrlsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CallbackURLsApi()
oBCallbackUrl1Param =  # OBCallbackUrl1 | Create an Callback URI
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xJwsSignature = xJwsSignature_example # String | Header containing a detached JWS signature of the body of the payload.
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create a callback URL
    api_response = api_instance.callback_urls_post(oBCallbackUrl1Param, authorization, xJwsSignature, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallbackURLsApi->callbackUrlsPost: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-jws-signature*
String
Header containing a detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBCallbackUrl1Param *

Responses

Status: 201 - Callback URL created

Name Type Format Description
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 415 - Unsupported Media Type

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait

Status: 500 - Internal Server Error


CertificateAssociations

organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdPut

Associate/de-associate a QSEAL/OBSEAL certificate with the given software statement


/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}/certificate/{OrganisationAssociativeCertificateType}/{CertificateOrKeyId}

Usage and SDK Samples

curl -X PUT "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}/certificate/{OrganisationAssociativeCertificateType}/{CertificateOrKeyId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.CertificateAssociationsApi;

import java.io.File;
import java.util.*;

public class CertificateAssociationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
        OAuth OAuth2SecurityReadWriteOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadWriteOps");
        OAuth2SecurityReadWriteOps.setAccessToken("YOUR ACCESS TOKEN");

        CertificateAssociationsApi apiInstance = new CertificateAssociationsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        String organisationAssociativeCertificateType = organisationAssociativeCertificateType_example; // String | The certificate type that can be associated with a software statement
        String certificateOrKeyId = certificateOrKeyId_example; // String | The certificate or key Id
        CertificateOrKeyAssociationSchema certificateOrKeyAssociation = ; // CertificateOrKeyAssociationSchema | Certificate or Key Association Payload
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdPut(organisationType, organisationId, softwareStatementId, organisationAssociativeCertificateType, certificateOrKeyId, certificateOrKeyAssociation);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateAssociationsApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdPut");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.CertificateAssociationsApi;

public class CertificateAssociationsApiExample {

    public static void main(String[] args) {
        CertificateAssociationsApi apiInstance = new CertificateAssociationsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        String organisationAssociativeCertificateType = organisationAssociativeCertificateType_example; // String | The certificate type that can be associated with a software statement
        String certificateOrKeyId = certificateOrKeyId_example; // String | The certificate or key Id
        CertificateOrKeyAssociationSchema certificateOrKeyAssociation = ; // CertificateOrKeyAssociationSchema | Certificate or Key Association Payload
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdPut(organisationType, organisationId, softwareStatementId, organisationAssociativeCertificateType, certificateOrKeyId, certificateOrKeyAssociation);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateAssociationsApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadWriteOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *softwareStatementId = softwareStatementId_example; // The software statement ID
String *organisationAssociativeCertificateType = organisationAssociativeCertificateType_example; // The certificate type that can be associated with a software statement
String *certificateOrKeyId = certificateOrKeyId_example; // The certificate or key Id
CertificateOrKeyAssociationSchema *certificateOrKeyAssociation = ; // Certificate or Key Association Payload

CertificateAssociationsApi *apiInstance = [[CertificateAssociationsApi alloc] init];

// Associate/de-associate a QSEAL/OBSEAL certificate with the given software statement
[apiInstance organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdPutWith:organisationType
    organisationId:organisationId
    softwareStatementId:softwareStatementId
    organisationAssociativeCertificateType:organisationAssociativeCertificateType
    certificateOrKeyId:certificateOrKeyId
    certificateOrKeyAssociation:certificateOrKeyAssociation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
var OAuth2SecurityReadWriteOps = defaultClient.authentications['OAuth2SecurityReadWriteOps'];
OAuth2SecurityReadWriteOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.CertificateAssociationsApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var softwareStatementId = softwareStatementId_example; // {String} The software statement ID

var organisationAssociativeCertificateType = organisationAssociativeCertificateType_example; // {String} The certificate type that can be associated with a software statement

var certificateOrKeyId = certificateOrKeyId_example; // {String} The certificate or key Id

var certificateOrKeyAssociation = ; // {CertificateOrKeyAssociationSchema} Certificate or Key Association Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdPut(organisationType, organisationId, softwareStatementIdorganisationAssociativeCertificateType, certificateOrKeyId, certificateOrKeyAssociation, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdPutExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CertificateAssociationsApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var softwareStatementId = softwareStatementId_example;  // String | The software statement ID
            var organisationAssociativeCertificateType = organisationAssociativeCertificateType_example;  // String | The certificate type that can be associated with a software statement
            var certificateOrKeyId = certificateOrKeyId_example;  // String | The certificate or key Id
            var certificateOrKeyAssociation = new CertificateOrKeyAssociationSchema(); // CertificateOrKeyAssociationSchema | Certificate or Key Association Payload

            try
            {
                // Associate/de-associate a QSEAL/OBSEAL certificate with the given software statement
                apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdPut(organisationType, organisationId, softwareStatementId, organisationAssociativeCertificateType, certificateOrKeyId, certificateOrKeyAssociation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CertificateAssociationsApi.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\CertificateAssociationsApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$softwareStatementId = softwareStatementId_example; // String | The software statement ID
$organisationAssociativeCertificateType = organisationAssociativeCertificateType_example; // String | The certificate type that can be associated with a software statement
$certificateOrKeyId = certificateOrKeyId_example; // String | The certificate or key Id
$certificateOrKeyAssociation = ; // CertificateOrKeyAssociationSchema | Certificate or Key Association Payload

try {
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdPut($organisationType, $organisationId, $softwareStatementId, $organisationAssociativeCertificateType, $certificateOrKeyId, $certificateOrKeyAssociation);
} catch (Exception $e) {
    echo 'Exception when calling CertificateAssociationsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CertificateAssociationsApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CertificateAssociationsApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $softwareStatementId = softwareStatementId_example; # String | The software statement ID
my $organisationAssociativeCertificateType = organisationAssociativeCertificateType_example; # String | The certificate type that can be associated with a software statement
my $certificateOrKeyId = certificateOrKeyId_example; # String | The certificate or key Id
my $certificateOrKeyAssociation = WWW::SwaggerClient::Object::CertificateOrKeyAssociationSchema->new(); # CertificateOrKeyAssociationSchema | Certificate or Key Association Payload

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdPut(organisationType => $organisationType, organisationId => $organisationId, softwareStatementId => $softwareStatementId, organisationAssociativeCertificateType => $organisationAssociativeCertificateType, certificateOrKeyId => $certificateOrKeyId, certificateOrKeyAssociation => $certificateOrKeyAssociation);
};
if ($@) {
    warn "Exception when calling CertificateAssociationsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdPut: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CertificateAssociationsApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
softwareStatementId = softwareStatementId_example # String | The software statement ID
organisationAssociativeCertificateType = organisationAssociativeCertificateType_example # String | The certificate type that can be associated with a software statement
certificateOrKeyId = certificateOrKeyId_example # String | The certificate or key Id
certificateOrKeyAssociation =  # CertificateOrKeyAssociationSchema | Certificate or Key Association Payload

try: 
    # Associate/de-associate a QSEAL/OBSEAL certificate with the given software statement
    api_instance.organisation_organisation_type_organisation_id_software_statement_software_statement_id_certificate_organisation_associative_certificate_type_certificate_or_key_id_put(organisationType, organisationId, softwareStatementId, organisationAssociativeCertificateType, certificateOrKeyId, certificateOrKeyAssociation)
except ApiException as e:
    print("Exception when calling CertificateAssociationsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdPut: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
SoftwareStatementId*
String
The software statement ID
Required
OrganisationAssociativeCertificateType*
String
The certificate type that can be associated with a software statement
Required
CertificateOrKeyId*
String
The certificate or key Id
Required
Body parameters
Name Description
certificateOrKeyAssociation *

Responses

Status: 200 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 204 - No Content

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 409 - Conflict

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

CertificateValidation

certificateValidatePost

Validate certificate


/certificate/validate

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/certificate/validate"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.CertificateValidationApi;

import java.io.File;
import java.util.*;

public class CertificateValidationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
        OAuth OAuth2SecurityReadOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadOps");
        OAuth2SecurityReadOps.setAccessToken("YOUR ACCESS TOKEN");

        CertificateValidationApi apiInstance = new CertificateValidationApi();
        CertificateValidationSchema certificateValidationRequestBody = ; // CertificateValidationSchema | Certificate Validation Payload
        try {
            apiInstance.certificateValidatePost(certificateValidationRequestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateValidationApi#certificateValidatePost");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.CertificateValidationApi;

public class CertificateValidationApiExample {

    public static void main(String[] args) {
        CertificateValidationApi apiInstance = new CertificateValidationApi();
        CertificateValidationSchema certificateValidationRequestBody = ; // CertificateValidationSchema | Certificate Validation Payload
        try {
            apiInstance.certificateValidatePost(certificateValidationRequestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertificateValidationApi#certificateValidatePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

CertificateValidationSchema *certificateValidationRequestBody = ; // Certificate Validation Payload

CertificateValidationApi *apiInstance = [[CertificateValidationApi alloc] init];

// Validate certificate
[apiInstance certificateValidatePostWith:certificateValidationRequestBody
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
var OAuth2SecurityReadOps = defaultClient.authentications['OAuth2SecurityReadOps'];
OAuth2SecurityReadOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.CertificateValidationApi()

var certificateValidationRequestBody = ; // {CertificateValidationSchema} Certificate Validation Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.certificateValidatePost(certificateValidationRequestBody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class certificateValidatePostExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CertificateValidationApi();
            var certificateValidationRequestBody = new CertificateValidationSchema(); // CertificateValidationSchema | Certificate Validation Payload

            try
            {
                // Validate certificate
                apiInstance.certificateValidatePost(certificateValidationRequestBody);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CertificateValidationApi.certificateValidatePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\CertificateValidationApi();
$certificateValidationRequestBody = ; // CertificateValidationSchema | Certificate Validation Payload

try {
    $api_instance->certificateValidatePost($certificateValidationRequestBody);
} catch (Exception $e) {
    echo 'Exception when calling CertificateValidationApi->certificateValidatePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CertificateValidationApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CertificateValidationApi->new();
my $certificateValidationRequestBody = WWW::SwaggerClient::Object::CertificateValidationSchema->new(); # CertificateValidationSchema | Certificate Validation Payload

eval { 
    $api_instance->certificateValidatePost(certificateValidationRequestBody => $certificateValidationRequestBody);
};
if ($@) {
    warn "Exception when calling CertificateValidationApi->certificateValidatePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CertificateValidationApi()
certificateValidationRequestBody =  # CertificateValidationSchema | Certificate Validation Payload

try: 
    # Validate certificate
    api_instance.certificate_validate_post(certificateValidationRequestBody)
except ApiException as e:
    print("Exception when calling CertificateValidationApi->certificateValidatePost: %s\n" % e)

Parameters

Body parameters
Name Description
certificateValidationRequestBody *

Responses

Status: 200 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

ClientRegistration

registerClientIdDelete

Delete a client by way of Client ID


/register/{ClientId}

Usage and SDK Samples

curl -X DELETE "https://localhost:8080/open-banking/v2.3/register/{ClientId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.ClientRegistrationApi;

import java.io.File;
import java.util.*;

public class ClientRegistrationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        ClientRegistrationApi apiInstance = new ClientRegistrationApi();
        String clientId = clientId_example; // String | The client ID
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        try {
            apiInstance.registerClientIdDelete(clientId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRegistrationApi#registerClientIdDelete");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.ClientRegistrationApi;

public class ClientRegistrationApiExample {

    public static void main(String[] args) {
        ClientRegistrationApi apiInstance = new ClientRegistrationApi();
        String clientId = clientId_example; // String | The client ID
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        try {
            apiInstance.registerClientIdDelete(clientId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRegistrationApi#registerClientIdDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *clientId = clientId_example; // The client ID
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750

ClientRegistrationApi *apiInstance = [[ClientRegistrationApi alloc] init];

// Delete a client by way of Client ID
[apiInstance registerClientIdDeleteWith:clientId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.ClientRegistrationApi()

var clientId = clientId_example; // {String} The client ID

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.registerClientIdDelete(clientId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class registerClientIdDeleteExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ClientRegistrationApi();
            var clientId = clientId_example;  // String | The client ID
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750

            try
            {
                // Delete a client by way of Client ID
                apiInstance.registerClientIdDelete(clientId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClientRegistrationApi.registerClientIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\ClientRegistrationApi();
$clientId = clientId_example; // String | The client ID
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750

try {
    $api_instance->registerClientIdDelete($clientId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ClientRegistrationApi->registerClientIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ClientRegistrationApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ClientRegistrationApi->new();
my $clientId = clientId_example; # String | The client ID
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750

eval { 
    $api_instance->registerClientIdDelete(clientId => $clientId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ClientRegistrationApi->registerClientIdDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ClientRegistrationApi()
clientId = clientId_example # String | The client ID
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750

try: 
    # Delete a client by way of Client ID
    api_instance.register_client_id_delete(clientId, authorization)
except ApiException as e:
    print("Exception when calling ClientRegistrationApi->registerClientIdDelete: %s\n" % e)

Parameters

Path parameters
Name Description
ClientId*
String
The client ID
Required
Header parameters
Name Description
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 204 - Client deleted

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 405 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

registerClientIdGet

Get a client by way of Client ID


/register/{ClientId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/register/{ClientId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.ClientRegistrationApi;

import java.io.File;
import java.util.*;

public class ClientRegistrationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        ClientRegistrationApi apiInstance = new ClientRegistrationApi();
        String clientId = clientId_example; // String | The client ID
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        try {
            inline_response_201 result = apiInstance.registerClientIdGet(clientId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRegistrationApi#registerClientIdGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.ClientRegistrationApi;

public class ClientRegistrationApiExample {

    public static void main(String[] args) {
        ClientRegistrationApi apiInstance = new ClientRegistrationApi();
        String clientId = clientId_example; // String | The client ID
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        try {
            inline_response_201 result = apiInstance.registerClientIdGet(clientId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRegistrationApi#registerClientIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *clientId = clientId_example; // The client ID
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750

ClientRegistrationApi *apiInstance = [[ClientRegistrationApi alloc] init];

// Get a client by way of Client ID
[apiInstance registerClientIdGetWith:clientId
    authorization:authorization
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.ClientRegistrationApi()

var clientId = clientId_example; // {String} The client ID

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerClientIdGet(clientId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class registerClientIdGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ClientRegistrationApi();
            var clientId = clientId_example;  // String | The client ID
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750

            try
            {
                // Get a client by way of Client ID
                inline_response_201 result = apiInstance.registerClientIdGet(clientId, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClientRegistrationApi.registerClientIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\ClientRegistrationApi();
$clientId = clientId_example; // String | The client ID
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750

try {
    $result = $api_instance->registerClientIdGet($clientId, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClientRegistrationApi->registerClientIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ClientRegistrationApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ClientRegistrationApi->new();
my $clientId = clientId_example; # String | The client ID
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750

eval { 
    my $result = $api_instance->registerClientIdGet(clientId => $clientId, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRegistrationApi->registerClientIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ClientRegistrationApi()
clientId = clientId_example # String | The client ID
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750

try: 
    # Get a client by way of Client ID
    api_response = api_instance.register_client_id_get(clientId, authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRegistrationApi->registerClientIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
ClientId*
String
The client ID
Required
Header parameters
Name Description
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Client registration

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

registerClientIdPut

Update a client by way of Client ID


/register/{ClientId}

Usage and SDK Samples

curl -X PUT "https://localhost:8080/open-banking/v2.3/register/{ClientId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.ClientRegistrationApi;

import java.io.File;
import java.util.*;

public class ClientRegistrationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        ClientRegistrationApi apiInstance = new ClientRegistrationApi();
        String clientId = clientId_example; // String | The client ID
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String requestBody = requestBody_example; // String | A request to register a Software Statement Assertion with an ASPSP
        try {
            inline_response_201 result = apiInstance.registerClientIdPut(clientId, authorization, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRegistrationApi#registerClientIdPut");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.ClientRegistrationApi;

public class ClientRegistrationApiExample {

    public static void main(String[] args) {
        ClientRegistrationApi apiInstance = new ClientRegistrationApi();
        String clientId = clientId_example; // String | The client ID
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String requestBody = requestBody_example; // String | A request to register a Software Statement Assertion with an ASPSP
        try {
            inline_response_201 result = apiInstance.registerClientIdPut(clientId, authorization, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRegistrationApi#registerClientIdPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *clientId = clientId_example; // The client ID
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *requestBody = requestBody_example; // A request to register a Software Statement Assertion with an ASPSP (optional)

ClientRegistrationApi *apiInstance = [[ClientRegistrationApi alloc] init];

// Update a client by way of Client ID
[apiInstance registerClientIdPutWith:clientId
    authorization:authorization
    requestBody:requestBody
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.ClientRegistrationApi()

var clientId = clientId_example; // {String} The client ID

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'requestBody': requestBody_example // {String} A request to register a Software Statement Assertion with an ASPSP
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerClientIdPut(clientId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class registerClientIdPutExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ClientRegistrationApi();
            var clientId = clientId_example;  // String | The client ID
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var requestBody = requestBody_example;  // String | A request to register a Software Statement Assertion with an ASPSP (optional) 

            try
            {
                // Update a client by way of Client ID
                inline_response_201 result = apiInstance.registerClientIdPut(clientId, authorization, requestBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClientRegistrationApi.registerClientIdPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\ClientRegistrationApi();
$clientId = clientId_example; // String | The client ID
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$requestBody = requestBody_example; // String | A request to register a Software Statement Assertion with an ASPSP

try {
    $result = $api_instance->registerClientIdPut($clientId, $authorization, $requestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClientRegistrationApi->registerClientIdPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ClientRegistrationApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ClientRegistrationApi->new();
my $clientId = clientId_example; # String | The client ID
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $requestBody = WWW::SwaggerClient::Object::String->new(); # String | A request to register a Software Statement Assertion with an ASPSP

eval { 
    my $result = $api_instance->registerClientIdPut(clientId => $clientId, authorization => $authorization, requestBody => $requestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRegistrationApi->registerClientIdPut: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ClientRegistrationApi()
clientId = clientId_example # String | The client ID
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
requestBody = requestBody_example # String | A request to register a Software Statement Assertion with an ASPSP (optional)

try: 
    # Update a client by way of Client ID
    api_response = api_instance.register_client_id_put(clientId, authorization, requestBody=requestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRegistrationApi->registerClientIdPut: %s\n" % e)

Parameters

Path parameters
Name Description
ClientId*
String
The client ID
Required
Header parameters
Name Description
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
Body parameters
Name Description
requestBody

Responses

Status: 200 - Client registration

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

registerPost

Register a client by way of a Software Statement Assertion

Endpoint will be secured by way of Mutual Authentication over TLS


/register

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/register"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.ClientRegistrationApi;

import java.io.File;
import java.util.*;

public class ClientRegistrationApiExample {

    public static void main(String[] args) {
        
        ClientRegistrationApi apiInstance = new ClientRegistrationApi();
        String requestBody = requestBody_example; // String | A request to register a Software Statement Assertion with an ASPSP
        try {
            inline_response_201 result = apiInstance.registerPost(requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRegistrationApi#registerPost");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.ClientRegistrationApi;

public class ClientRegistrationApiExample {

    public static void main(String[] args) {
        ClientRegistrationApi apiInstance = new ClientRegistrationApi();
        String requestBody = requestBody_example; // String | A request to register a Software Statement Assertion with an ASPSP
        try {
            inline_response_201 result = apiInstance.registerPost(requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientRegistrationApi#registerPost");
            e.printStackTrace();
        }
    }
}
String *requestBody = requestBody_example; // A request to register a Software Statement Assertion with an ASPSP (optional)

ClientRegistrationApi *apiInstance = [[ClientRegistrationApi alloc] init];

// Register a client by way of a Software Statement Assertion
[apiInstance registerPostWith:requestBody
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');

var api = new OpenBankingApi.ClientRegistrationApi()

var opts = { 
  'requestBody': requestBody_example // {String} A request to register a Software Statement Assertion with an ASPSP
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class registerPostExample
    {
        public void main()
        {
            
            var apiInstance = new ClientRegistrationApi();
            var requestBody = requestBody_example;  // String | A request to register a Software Statement Assertion with an ASPSP (optional) 

            try
            {
                // Register a client by way of a Software Statement Assertion
                inline_response_201 result = apiInstance.registerPost(requestBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClientRegistrationApi.registerPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClientRegistrationApi();
$requestBody = requestBody_example; // String | A request to register a Software Statement Assertion with an ASPSP

try {
    $result = $api_instance->registerPost($requestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClientRegistrationApi->registerPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ClientRegistrationApi;

my $api_instance = WWW::SwaggerClient::ClientRegistrationApi->new();
my $requestBody = WWW::SwaggerClient::Object::String->new(); # String | A request to register a Software Statement Assertion with an ASPSP

eval { 
    my $result = $api_instance->registerPost(requestBody => $requestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientRegistrationApi->registerPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ClientRegistrationApi()
requestBody = requestBody_example # String | A request to register a Software Statement Assertion with an ASPSP (optional)

try: 
    # Register a client by way of a Software Statement Assertion
    api_response = api_instance.register_post(requestBody=requestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientRegistrationApi->registerPost: %s\n" % e)

Parameters

Body parameters
Name Description
requestBody

Responses

Status: 201 - Client registration

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Contacts

organisationOrganisationTypeOrganisationIdContactContactTypeGet

Get the business or the technical contacts for the given organisation


/organisation/{OrganisationType}/{OrganisationId}/contact/{ContactType}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/contact/{ContactType}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.ContactsApi;

import java.io.File;
import java.util.*;

public class ContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
        OAuth OAuth2SecurityReadOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadOps");
        OAuth2SecurityReadOps.setAccessToken("YOUR ACCESS TOKEN");

        ContactsApi apiInstance = new ContactsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String contactType = contactType_example; // String | The contact type
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdContactContactTypeGet(organisationType, organisationId, contactType);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#organisationOrganisationTypeOrganisationIdContactContactTypeGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String contactType = contactType_example; // String | The contact type
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdContactContactTypeGet(organisationType, organisationId, contactType);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#organisationOrganisationTypeOrganisationIdContactContactTypeGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *contactType = contactType_example; // The contact type

ContactsApi *apiInstance = [[ContactsApi alloc] init];

// Get the business or the technical contacts for the given organisation
[apiInstance organisationOrganisationTypeOrganisationIdContactContactTypeGetWith:organisationType
    organisationId:organisationId
    contactType:contactType
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
var OAuth2SecurityReadOps = defaultClient.authentications['OAuth2SecurityReadOps'];
OAuth2SecurityReadOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.ContactsApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var contactType = contactType_example; // {String} The contact type


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdContactContactTypeGet(organisationType, organisationId, contactType, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdContactContactTypeGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ContactsApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var contactType = contactType_example;  // String | The contact type

            try
            {
                // Get the business or the technical contacts for the given organisation
                apiInstance.organisationOrganisationTypeOrganisationIdContactContactTypeGet(organisationType, organisationId, contactType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.organisationOrganisationTypeOrganisationIdContactContactTypeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\ContactsApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$contactType = contactType_example; // String | The contact type

try {
    $api_instance->organisationOrganisationTypeOrganisationIdContactContactTypeGet($organisationType, $organisationId, $contactType);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->organisationOrganisationTypeOrganisationIdContactContactTypeGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $contactType = contactType_example; # String | The contact type

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdContactContactTypeGet(organisationType => $organisationType, organisationId => $organisationId, contactType => $contactType);
};
if ($@) {
    warn "Exception when calling ContactsApi->organisationOrganisationTypeOrganisationIdContactContactTypeGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ContactsApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
contactType = contactType_example # String | The contact type

try: 
    # Get the business or the technical contacts for the given organisation
    api_instance.organisation_organisation_type_organisation_id_contact_contact_type_get(organisationType, organisationId, contactType)
except ApiException as e:
    print("Exception when calling ContactsApi->organisationOrganisationTypeOrganisationIdContactContactTypeGet: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
ContactType*
String
The contact type
Required

Responses

Status: 200 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypeOrganisationIdContactContactTypePut

Update the business or the technical contacts for the given organisation


/organisation/{OrganisationType}/{OrganisationId}/contact/{ContactType}

Usage and SDK Samples

curl -X PUT "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/contact/{ContactType}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.ContactsApi;

import java.io.File;
import java.util.*;

public class ContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
        OAuth OAuth2SecurityReadWriteOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadWriteOps");
        OAuth2SecurityReadWriteOps.setAccessToken("YOUR ACCESS TOKEN");

        ContactsApi apiInstance = new ContactsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String contactType = contactType_example; // String | The contact type
        ContactSchema contact = ; // ContactSchema | Properties to update business/technical contacts
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdContactContactTypePut(organisationType, organisationId, contactType, contact);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#organisationOrganisationTypeOrganisationIdContactContactTypePut");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String contactType = contactType_example; // String | The contact type
        ContactSchema contact = ; // ContactSchema | Properties to update business/technical contacts
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdContactContactTypePut(organisationType, organisationId, contactType, contact);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#organisationOrganisationTypeOrganisationIdContactContactTypePut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadWriteOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *contactType = contactType_example; // The contact type
ContactSchema *contact = ; // Properties to update business/technical contacts

ContactsApi *apiInstance = [[ContactsApi alloc] init];

// Update the business or the technical contacts for the given organisation
[apiInstance organisationOrganisationTypeOrganisationIdContactContactTypePutWith:organisationType
    organisationId:organisationId
    contactType:contactType
    contact:contact
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
var OAuth2SecurityReadWriteOps = defaultClient.authentications['OAuth2SecurityReadWriteOps'];
OAuth2SecurityReadWriteOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.ContactsApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var contactType = contactType_example; // {String} The contact type

var contact = ; // {ContactSchema} Properties to update business/technical contacts


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdContactContactTypePut(organisationType, organisationId, contactType, contact, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdContactContactTypePutExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ContactsApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var contactType = contactType_example;  // String | The contact type
            var contact = new ContactSchema(); // ContactSchema | Properties to update business/technical contacts

            try
            {
                // Update the business or the technical contacts for the given organisation
                apiInstance.organisationOrganisationTypeOrganisationIdContactContactTypePut(organisationType, organisationId, contactType, contact);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.organisationOrganisationTypeOrganisationIdContactContactTypePut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\ContactsApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$contactType = contactType_example; // String | The contact type
$contact = ; // ContactSchema | Properties to update business/technical contacts

try {
    $api_instance->organisationOrganisationTypeOrganisationIdContactContactTypePut($organisationType, $organisationId, $contactType, $contact);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->organisationOrganisationTypeOrganisationIdContactContactTypePut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $contactType = contactType_example; # String | The contact type
my $contact = WWW::SwaggerClient::Object::ContactSchema->new(); # ContactSchema | Properties to update business/technical contacts

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdContactContactTypePut(organisationType => $organisationType, organisationId => $organisationId, contactType => $contactType, contact => $contact);
};
if ($@) {
    warn "Exception when calling ContactsApi->organisationOrganisationTypeOrganisationIdContactContactTypePut: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ContactsApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
contactType = contactType_example # String | The contact type
contact =  # ContactSchema | Properties to update business/technical contacts

try: 
    # Update the business or the technical contacts for the given organisation
    api_instance.organisation_organisation_type_organisation_id_contact_contact_type_put(organisationType, organisationId, contactType, contact)
except ApiException as e:
    print("Exception when calling ContactsApi->organisationOrganisationTypeOrganisationIdContactContactTypePut: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
ContactType*
String
The contact type
Required
Body parameters
Name Description
contact *

Responses

Status: 200 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

DirectDebits

getAccountsAccountIdDirectDebits

Get Direct Debits


/accounts/{AccountId}/direct-debits

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/accounts/{AccountId}/direct-debits"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.DirectDebitsApi;

import java.io.File;
import java.util.*;

public class DirectDebitsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        DirectDebitsApi apiInstance = new DirectDebitsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadDirectDebit1 result = apiInstance.getAccountsAccountIdDirectDebits(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DirectDebitsApi#getAccountsAccountIdDirectDebits");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.DirectDebitsApi;

public class DirectDebitsApiExample {

    public static void main(String[] args) {
        DirectDebitsApi apiInstance = new DirectDebitsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadDirectDebit1 result = apiInstance.getAccountsAccountIdDirectDebits(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DirectDebitsApi#getAccountsAccountIdDirectDebits");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

DirectDebitsApi *apiInstance = [[DirectDebitsApi alloc] init];

// Get Direct Debits
[apiInstance getAccountsAccountIdDirectDebitsWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadDirectDebit1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.DirectDebitsApi()

var accountId = accountId_example; // {String} AccountId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdDirectDebits(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdDirectDebitsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DirectDebitsApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Direct Debits
                OBReadDirectDebit1 result = apiInstance.getAccountsAccountIdDirectDebits(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DirectDebitsApi.getAccountsAccountIdDirectDebits: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DirectDebitsApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getAccountsAccountIdDirectDebits($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectDebitsApi->getAccountsAccountIdDirectDebits: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DirectDebitsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DirectDebitsApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getAccountsAccountIdDirectDebits(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DirectDebitsApi->getAccountsAccountIdDirectDebits: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DirectDebitsApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Direct Debits
    api_response = api_instance.get_accounts_account_id_direct_debits(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DirectDebitsApi->getAccountsAccountIdDirectDebits: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Direct Debits Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getDirectDebits

Get Direct Debits


/direct-debits

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/direct-debits"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.DirectDebitsApi;

import java.io.File;
import java.util.*;

public class DirectDebitsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        DirectDebitsApi apiInstance = new DirectDebitsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadDirectDebit1 result = apiInstance.getDirectDebits(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DirectDebitsApi#getDirectDebits");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.DirectDebitsApi;

public class DirectDebitsApiExample {

    public static void main(String[] args) {
        DirectDebitsApi apiInstance = new DirectDebitsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadDirectDebit1 result = apiInstance.getDirectDebits(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DirectDebitsApi#getDirectDebits");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

DirectDebitsApi *apiInstance = [[DirectDebitsApi alloc] init];

// Get Direct Debits
[apiInstance getDirectDebitsWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadDirectDebit1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.DirectDebitsApi()

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDirectDebits(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDirectDebitsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DirectDebitsApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Direct Debits
                OBReadDirectDebit1 result = apiInstance.getDirectDebits(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DirectDebitsApi.getDirectDebits: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DirectDebitsApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getDirectDebits($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectDebitsApi->getDirectDebits: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DirectDebitsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DirectDebitsApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getDirectDebits(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DirectDebitsApi->getDirectDebits: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DirectDebitsApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Direct Debits
    api_response = api_instance.get_direct_debits(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DirectDebitsApi->getDirectDebits: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Direct Debits Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

DomesticPayments

createDomesticPaymentConsents

Create Domestic Payment Consents


/domestic-payment-consents

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/domestic-payment-consents"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.DomesticPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        OBWriteDomesticConsent3 oBWriteDomesticConsent3Param = ; // OBWriteDomesticConsent3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticConsentResponse3 result = apiInstance.createDomesticPaymentConsents(oBWriteDomesticConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#createDomesticPaymentConsents");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.DomesticPaymentsApi;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        OBWriteDomesticConsent3 oBWriteDomesticConsent3Param = ; // OBWriteDomesticConsent3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticConsentResponse3 result = apiInstance.createDomesticPaymentConsents(oBWriteDomesticConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#createDomesticPaymentConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteDomesticConsent3 *oBWriteDomesticConsent3Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

DomesticPaymentsApi *apiInstance = [[DomesticPaymentsApi alloc] init];

// Create Domestic Payment Consents
[apiInstance createDomesticPaymentConsentsWith:oBWriteDomesticConsent3Param
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteDomesticConsentResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.DomesticPaymentsApi()

var oBWriteDomesticConsent3Param = ; // {OBWriteDomesticConsent3} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.


var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDomesticPaymentConsents(oBWriteDomesticConsent3Param, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDomesticPaymentConsentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var oBWriteDomesticConsent3Param = new OBWriteDomesticConsent3(); // OBWriteDomesticConsent3 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create Domestic Payment Consents
                OBWriteDomesticConsentResponse3 result = apiInstance.createDomesticPaymentConsents(oBWriteDomesticConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticPaymentsApi.createDomesticPaymentConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DomesticPaymentsApi();
$oBWriteDomesticConsent3Param = ; // OBWriteDomesticConsent3 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createDomesticPaymentConsents($oBWriteDomesticConsent3Param, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticPaymentsApi->createDomesticPaymentConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $oBWriteDomesticConsent3Param = WWW::SwaggerClient::Object::OBWriteDomesticConsent3->new(); # OBWriteDomesticConsent3 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createDomesticPaymentConsents(oBWriteDomesticConsent3Param => $oBWriteDomesticConsent3Param, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticPaymentsApi->createDomesticPaymentConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticPaymentsApi()
oBWriteDomesticConsent3Param =  # OBWriteDomesticConsent3 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create Domestic Payment Consents
    api_response = api_instance.create_domestic_payment_consents(oBWriteDomesticConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticPaymentsApi->createDomesticPaymentConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBWriteDomesticConsent3Param *

Responses

Status: 201 - Domestic Payment Consents Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

createDomesticPayments

Create Domestic Payments


/domestic-payments

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/domestic-payments"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.DomesticPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        OBWriteDomestic2 oBWriteDomestic2Param = ; // OBWriteDomestic2 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticResponse3 result = apiInstance.createDomesticPayments(oBWriteDomestic2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#createDomesticPayments");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.DomesticPaymentsApi;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        OBWriteDomestic2 oBWriteDomestic2Param = ; // OBWriteDomestic2 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticResponse3 result = apiInstance.createDomesticPayments(oBWriteDomestic2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#createDomesticPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteDomestic2 *oBWriteDomestic2Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

DomesticPaymentsApi *apiInstance = [[DomesticPaymentsApi alloc] init];

// Create Domestic Payments
[apiInstance createDomesticPaymentsWith:oBWriteDomestic2Param
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteDomesticResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.DomesticPaymentsApi()

var oBWriteDomestic2Param = ; // {OBWriteDomestic2} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.


var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDomesticPayments(oBWriteDomestic2Param, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDomesticPaymentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var oBWriteDomestic2Param = new OBWriteDomestic2(); // OBWriteDomestic2 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create Domestic Payments
                OBWriteDomesticResponse3 result = apiInstance.createDomesticPayments(oBWriteDomestic2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticPaymentsApi.createDomesticPayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DomesticPaymentsApi();
$oBWriteDomestic2Param = ; // OBWriteDomestic2 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createDomesticPayments($oBWriteDomestic2Param, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticPaymentsApi->createDomesticPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $oBWriteDomestic2Param = WWW::SwaggerClient::Object::OBWriteDomestic2->new(); # OBWriteDomestic2 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createDomesticPayments(oBWriteDomestic2Param => $oBWriteDomestic2Param, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticPaymentsApi->createDomesticPayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticPaymentsApi()
oBWriteDomestic2Param =  # OBWriteDomestic2 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create Domestic Payments
    api_response = api_instance.create_domestic_payments(oBWriteDomestic2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticPaymentsApi->createDomesticPayments: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBWriteDomestic2Param *

Responses

Status: 201 - Domestic Payments Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getDomesticPaymentConsentsConsentId

Get Domestic Payment Consents


/domestic-payment-consents/{ConsentId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/domestic-payment-consents/{ConsentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.DomesticPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticConsentResponse3 result = apiInstance.getDomesticPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.DomesticPaymentsApi;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticConsentResponse3 result = apiInstance.getDomesticPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

DomesticPaymentsApi *apiInstance = [[DomesticPaymentsApi alloc] init];

// Get Domestic Payment Consents
[apiInstance getDomesticPaymentConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteDomesticConsentResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.DomesticPaymentsApi()

var consentId = consentId_example; // {String} ConsentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticPaymentConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticPaymentConsentsConsentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Domestic Payment Consents
                OBWriteDomesticConsentResponse3 result = apiInstance.getDomesticPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticPaymentsApi.getDomesticPaymentConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DomesticPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getDomesticPaymentConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getDomesticPaymentConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticPaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Domestic Payment Consents
    api_response = api_instance.get_domestic_payment_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Domestic Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getDomesticPaymentConsentsConsentIdFundsConfirmation

Get Domestic Payment Consents


/domestic-payment-consents/{ConsentId}/funds-confirmation

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/domestic-payment-consents/{ConsentId}/funds-confirmation"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.DomesticPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteFundsConfirmationResponse1 result = apiInstance.getDomesticPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentConsentsConsentIdFundsConfirmation");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.DomesticPaymentsApi;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteFundsConfirmationResponse1 result = apiInstance.getDomesticPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentConsentsConsentIdFundsConfirmation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

DomesticPaymentsApi *apiInstance = [[DomesticPaymentsApi alloc] init];

// Get Domestic Payment Consents
[apiInstance getDomesticPaymentConsentsConsentIdFundsConfirmationWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteFundsConfirmationResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.DomesticPaymentsApi()

var consentId = consentId_example; // {String} ConsentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticPaymentConsentsConsentIdFundsConfirmationExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Domestic Payment Consents
                OBWriteFundsConfirmationResponse1 result = apiInstance.getDomesticPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticPaymentsApi.getDomesticPaymentConsentsConsentIdFundsConfirmation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DomesticPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getDomesticPaymentConsentsConsentIdFundsConfirmation($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentIdFundsConfirmation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getDomesticPaymentConsentsConsentIdFundsConfirmation(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentIdFundsConfirmation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticPaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Domestic Payment Consents
    api_response = api_instance.get_domestic_payment_consents_consent_id_funds_confirmation(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentIdFundsConfirmation: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Domestic Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getDomesticPaymentsDomesticPaymentId

Get Domestic Payments


/domestic-payments/{DomesticPaymentId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/domestic-payments/{DomesticPaymentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.DomesticPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticResponse3 result = apiInstance.getDomesticPaymentsDomesticPaymentId(domesticPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentsDomesticPaymentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.DomesticPaymentsApi;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticResponse3 result = apiInstance.getDomesticPaymentsDomesticPaymentId(domesticPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentsDomesticPaymentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *domesticPaymentId = domesticPaymentId_example; // DomesticPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

DomesticPaymentsApi *apiInstance = [[DomesticPaymentsApi alloc] init];

// Get Domestic Payments
[apiInstance getDomesticPaymentsDomesticPaymentIdWith:domesticPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteDomesticResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.DomesticPaymentsApi()

var domesticPaymentId = domesticPaymentId_example; // {String} DomesticPaymentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticPaymentsDomesticPaymentId(domesticPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticPaymentsDomesticPaymentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var domesticPaymentId = domesticPaymentId_example;  // String | DomesticPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Domestic Payments
                OBWriteDomesticResponse3 result = apiInstance.getDomesticPaymentsDomesticPaymentId(domesticPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticPaymentsApi.getDomesticPaymentsDomesticPaymentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DomesticPaymentsApi();
$domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getDomesticPaymentsDomesticPaymentId($domesticPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticPaymentsApi->getDomesticPaymentsDomesticPaymentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $domesticPaymentId = domesticPaymentId_example; # String | DomesticPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getDomesticPaymentsDomesticPaymentId(domesticPaymentId => $domesticPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticPaymentsApi->getDomesticPaymentsDomesticPaymentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticPaymentsApi()
domesticPaymentId = domesticPaymentId_example # String | DomesticPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Domestic Payments
    api_response = api_instance.get_domestic_payments_domestic_payment_id(domesticPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticPaymentsApi->getDomesticPaymentsDomesticPaymentId: %s\n" % e)

Parameters

Path parameters
Name Description
DomesticPaymentId*
String
DomesticPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Domestic Payments Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

DomesticScheduledPayments

createDomesticScheduledPaymentConsents

Create Domestic Scheduled Payment Consents


/domestic-scheduled-payment-consents

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/domestic-scheduled-payment-consents"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.DomesticScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        OBWriteDomesticScheduledConsent3 oBWriteDomesticScheduledConsent3Param = ; // OBWriteDomesticScheduledConsent3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticScheduledConsentResponse3 result = apiInstance.createDomesticScheduledPaymentConsents(oBWriteDomesticScheduledConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#createDomesticScheduledPaymentConsents");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.DomesticScheduledPaymentsApi;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        OBWriteDomesticScheduledConsent3 oBWriteDomesticScheduledConsent3Param = ; // OBWriteDomesticScheduledConsent3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticScheduledConsentResponse3 result = apiInstance.createDomesticScheduledPaymentConsents(oBWriteDomesticScheduledConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#createDomesticScheduledPaymentConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteDomesticScheduledConsent3 *oBWriteDomesticScheduledConsent3Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

DomesticScheduledPaymentsApi *apiInstance = [[DomesticScheduledPaymentsApi alloc] init];

// Create Domestic Scheduled Payment Consents
[apiInstance createDomesticScheduledPaymentConsentsWith:oBWriteDomesticScheduledConsent3Param
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteDomesticScheduledConsentResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.DomesticScheduledPaymentsApi()

var oBWriteDomesticScheduledConsent3Param = ; // {OBWriteDomesticScheduledConsent3} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.


var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDomesticScheduledPaymentConsents(oBWriteDomesticScheduledConsent3Param, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDomesticScheduledPaymentConsentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticScheduledPaymentsApi();
            var oBWriteDomesticScheduledConsent3Param = new OBWriteDomesticScheduledConsent3(); // OBWriteDomesticScheduledConsent3 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create Domestic Scheduled Payment Consents
                OBWriteDomesticScheduledConsentResponse3 result = apiInstance.createDomesticScheduledPaymentConsents(oBWriteDomesticScheduledConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticScheduledPaymentsApi.createDomesticScheduledPaymentConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DomesticScheduledPaymentsApi();
$oBWriteDomesticScheduledConsent3Param = ; // OBWriteDomesticScheduledConsent3 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createDomesticScheduledPaymentConsents($oBWriteDomesticScheduledConsent3Param, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPaymentConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticScheduledPaymentsApi->new();
my $oBWriteDomesticScheduledConsent3Param = WWW::SwaggerClient::Object::OBWriteDomesticScheduledConsent3->new(); # OBWriteDomesticScheduledConsent3 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createDomesticScheduledPaymentConsents(oBWriteDomesticScheduledConsent3Param => $oBWriteDomesticScheduledConsent3Param, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPaymentConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticScheduledPaymentsApi()
oBWriteDomesticScheduledConsent3Param =  # OBWriteDomesticScheduledConsent3 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create Domestic Scheduled Payment Consents
    api_response = api_instance.create_domestic_scheduled_payment_consents(oBWriteDomesticScheduledConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPaymentConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBWriteDomesticScheduledConsent3Param *

Responses

Status: 201 - Domestic Scheduled Payment Consents Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

createDomesticScheduledPayments

Create Domestic Scheduled Payments


/domestic-scheduled-payments

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/domestic-scheduled-payments"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.DomesticScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        OBWriteDomesticScheduled2 oBWriteDomesticScheduled2Param = ; // OBWriteDomesticScheduled2 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticScheduledResponse3 result = apiInstance.createDomesticScheduledPayments(oBWriteDomesticScheduled2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#createDomesticScheduledPayments");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.DomesticScheduledPaymentsApi;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        OBWriteDomesticScheduled2 oBWriteDomesticScheduled2Param = ; // OBWriteDomesticScheduled2 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticScheduledResponse3 result = apiInstance.createDomesticScheduledPayments(oBWriteDomesticScheduled2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#createDomesticScheduledPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteDomesticScheduled2 *oBWriteDomesticScheduled2Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

DomesticScheduledPaymentsApi *apiInstance = [[DomesticScheduledPaymentsApi alloc] init];

// Create Domestic Scheduled Payments
[apiInstance createDomesticScheduledPaymentsWith:oBWriteDomesticScheduled2Param
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteDomesticScheduledResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.DomesticScheduledPaymentsApi()

var oBWriteDomesticScheduled2Param = ; // {OBWriteDomesticScheduled2} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.


var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDomesticScheduledPayments(oBWriteDomesticScheduled2Param, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDomesticScheduledPaymentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticScheduledPaymentsApi();
            var oBWriteDomesticScheduled2Param = new OBWriteDomesticScheduled2(); // OBWriteDomesticScheduled2 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create Domestic Scheduled Payments
                OBWriteDomesticScheduledResponse3 result = apiInstance.createDomesticScheduledPayments(oBWriteDomesticScheduled2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticScheduledPaymentsApi.createDomesticScheduledPayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DomesticScheduledPaymentsApi();
$oBWriteDomesticScheduled2Param = ; // OBWriteDomesticScheduled2 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createDomesticScheduledPayments($oBWriteDomesticScheduled2Param, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticScheduledPaymentsApi->new();
my $oBWriteDomesticScheduled2Param = WWW::SwaggerClient::Object::OBWriteDomesticScheduled2->new(); # OBWriteDomesticScheduled2 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createDomesticScheduledPayments(oBWriteDomesticScheduled2Param => $oBWriteDomesticScheduled2Param, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticScheduledPaymentsApi()
oBWriteDomesticScheduled2Param =  # OBWriteDomesticScheduled2 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create Domestic Scheduled Payments
    api_response = api_instance.create_domestic_scheduled_payments(oBWriteDomesticScheduled2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPayments: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBWriteDomesticScheduled2Param *

Responses

Status: 201 - Domestic Scheduled Payments Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getDomesticScheduledPaymentConsentsConsentId

Get Domestic Scheduled Payment Consents


/domestic-scheduled-payment-consents/{ConsentId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/domestic-scheduled-payment-consents/{ConsentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.DomesticScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticScheduledConsentResponse3 result = apiInstance.getDomesticScheduledPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#getDomesticScheduledPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.DomesticScheduledPaymentsApi;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticScheduledConsentResponse3 result = apiInstance.getDomesticScheduledPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#getDomesticScheduledPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

DomesticScheduledPaymentsApi *apiInstance = [[DomesticScheduledPaymentsApi alloc] init];

// Get Domestic Scheduled Payment Consents
[apiInstance getDomesticScheduledPaymentConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteDomesticScheduledConsentResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.DomesticScheduledPaymentsApi()

var consentId = consentId_example; // {String} ConsentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticScheduledPaymentConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticScheduledPaymentConsentsConsentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticScheduledPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Domestic Scheduled Payment Consents
                OBWriteDomesticScheduledConsentResponse3 result = apiInstance.getDomesticScheduledPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticScheduledPaymentsApi.getDomesticScheduledPaymentConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DomesticScheduledPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getDomesticScheduledPaymentConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticScheduledPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getDomesticScheduledPaymentConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticScheduledPaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Domestic Scheduled Payment Consents
    api_response = api_instance.get_domestic_scheduled_payment_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Domestic Scheduled Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getDomesticScheduledPaymentsDomesticScheduledPaymentId

Get Domestic Scheduled Payments


/domestic-scheduled-payments/{DomesticScheduledPaymentId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/domestic-scheduled-payments/{DomesticScheduledPaymentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.DomesticScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        String domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticScheduledResponse3 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#getDomesticScheduledPaymentsDomesticScheduledPaymentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.DomesticScheduledPaymentsApi;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        String domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticScheduledResponse3 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#getDomesticScheduledPaymentsDomesticScheduledPaymentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *domesticScheduledPaymentId = domesticScheduledPaymentId_example; // DomesticScheduledPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

DomesticScheduledPaymentsApi *apiInstance = [[DomesticScheduledPaymentsApi alloc] init];

// Get Domestic Scheduled Payments
[apiInstance getDomesticScheduledPaymentsDomesticScheduledPaymentIdWith:domesticScheduledPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteDomesticScheduledResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.DomesticScheduledPaymentsApi()

var domesticScheduledPaymentId = domesticScheduledPaymentId_example; // {String} DomesticScheduledPaymentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticScheduledPaymentsDomesticScheduledPaymentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticScheduledPaymentsApi();
            var domesticScheduledPaymentId = domesticScheduledPaymentId_example;  // String | DomesticScheduledPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Domestic Scheduled Payments
                OBWriteDomesticScheduledResponse3 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticScheduledPaymentsApi.getDomesticScheduledPaymentsDomesticScheduledPaymentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DomesticScheduledPaymentsApi();
$domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getDomesticScheduledPaymentsDomesticScheduledPaymentId($domesticScheduledPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentsDomesticScheduledPaymentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticScheduledPaymentsApi->new();
my $domesticScheduledPaymentId = domesticScheduledPaymentId_example; # String | DomesticScheduledPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId => $domesticScheduledPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentsDomesticScheduledPaymentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticScheduledPaymentsApi()
domesticScheduledPaymentId = domesticScheduledPaymentId_example # String | DomesticScheduledPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Domestic Scheduled Payments
    api_response = api_instance.get_domestic_scheduled_payments_domestic_scheduled_payment_id(domesticScheduledPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentsDomesticScheduledPaymentId: %s\n" % e)

Parameters

Path parameters
Name Description
DomesticScheduledPaymentId*
String
DomesticScheduledPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Domestic Scheduled Payments Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

DomesticStandingOrders

createDomesticStandingOrderConsents

Create Domestic Standing Order Consents


/domestic-standing-order-consents

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/domestic-standing-order-consents"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.DomesticStandingOrdersApi;

import java.io.File;
import java.util.*;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        OBWriteDomesticStandingOrderConsent4 oBWriteDomesticStandingOrderConsent4Param = ; // OBWriteDomesticStandingOrderConsent4 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticStandingOrderConsentResponse4 result = apiInstance.createDomesticStandingOrderConsents(oBWriteDomesticStandingOrderConsent4Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#createDomesticStandingOrderConsents");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.DomesticStandingOrdersApi;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        OBWriteDomesticStandingOrderConsent4 oBWriteDomesticStandingOrderConsent4Param = ; // OBWriteDomesticStandingOrderConsent4 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticStandingOrderConsentResponse4 result = apiInstance.createDomesticStandingOrderConsents(oBWriteDomesticStandingOrderConsent4Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#createDomesticStandingOrderConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteDomesticStandingOrderConsent4 *oBWriteDomesticStandingOrderConsent4Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

DomesticStandingOrdersApi *apiInstance = [[DomesticStandingOrdersApi alloc] init];

// Create Domestic Standing Order Consents
[apiInstance createDomesticStandingOrderConsentsWith:oBWriteDomesticStandingOrderConsent4Param
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteDomesticStandingOrderConsentResponse4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.DomesticStandingOrdersApi()

var oBWriteDomesticStandingOrderConsent4Param = ; // {OBWriteDomesticStandingOrderConsent4} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.


var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDomesticStandingOrderConsents(oBWriteDomesticStandingOrderConsent4Param, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDomesticStandingOrderConsentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticStandingOrdersApi();
            var oBWriteDomesticStandingOrderConsent4Param = new OBWriteDomesticStandingOrderConsent4(); // OBWriteDomesticStandingOrderConsent4 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create Domestic Standing Order Consents
                OBWriteDomesticStandingOrderConsentResponse4 result = apiInstance.createDomesticStandingOrderConsents(oBWriteDomesticStandingOrderConsent4Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticStandingOrdersApi.createDomesticStandingOrderConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DomesticStandingOrdersApi();
$oBWriteDomesticStandingOrderConsent4Param = ; // OBWriteDomesticStandingOrderConsent4 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createDomesticStandingOrderConsents($oBWriteDomesticStandingOrderConsent4Param, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrderConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticStandingOrdersApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticStandingOrdersApi->new();
my $oBWriteDomesticStandingOrderConsent4Param = WWW::SwaggerClient::Object::OBWriteDomesticStandingOrderConsent4->new(); # OBWriteDomesticStandingOrderConsent4 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createDomesticStandingOrderConsents(oBWriteDomesticStandingOrderConsent4Param => $oBWriteDomesticStandingOrderConsent4Param, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrderConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticStandingOrdersApi()
oBWriteDomesticStandingOrderConsent4Param =  # OBWriteDomesticStandingOrderConsent4 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create Domestic Standing Order Consents
    api_response = api_instance.create_domestic_standing_order_consents(oBWriteDomesticStandingOrderConsent4Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrderConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBWriteDomesticStandingOrderConsent4Param *

Responses

Status: 201 - Domestic Standing Order Consents Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

createDomesticStandingOrders

Create Domestic Standing Orders


/domestic-standing-orders

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/domestic-standing-orders"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.DomesticStandingOrdersApi;

import java.io.File;
import java.util.*;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        OBWriteDomesticStandingOrder3 oBWriteDomesticStandingOrder3Param = ; // OBWriteDomesticStandingOrder3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticStandingOrderResponse4 result = apiInstance.createDomesticStandingOrders(oBWriteDomesticStandingOrder3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#createDomesticStandingOrders");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.DomesticStandingOrdersApi;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        OBWriteDomesticStandingOrder3 oBWriteDomesticStandingOrder3Param = ; // OBWriteDomesticStandingOrder3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticStandingOrderResponse4 result = apiInstance.createDomesticStandingOrders(oBWriteDomesticStandingOrder3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#createDomesticStandingOrders");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteDomesticStandingOrder3 *oBWriteDomesticStandingOrder3Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

DomesticStandingOrdersApi *apiInstance = [[DomesticStandingOrdersApi alloc] init];

// Create Domestic Standing Orders
[apiInstance createDomesticStandingOrdersWith:oBWriteDomesticStandingOrder3Param
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteDomesticStandingOrderResponse4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.DomesticStandingOrdersApi()

var oBWriteDomesticStandingOrder3Param = ; // {OBWriteDomesticStandingOrder3} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.


var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDomesticStandingOrders(oBWriteDomesticStandingOrder3Param, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDomesticStandingOrdersExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticStandingOrdersApi();
            var oBWriteDomesticStandingOrder3Param = new OBWriteDomesticStandingOrder3(); // OBWriteDomesticStandingOrder3 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create Domestic Standing Orders
                OBWriteDomesticStandingOrderResponse4 result = apiInstance.createDomesticStandingOrders(oBWriteDomesticStandingOrder3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticStandingOrdersApi.createDomesticStandingOrders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DomesticStandingOrdersApi();
$oBWriteDomesticStandingOrder3Param = ; // OBWriteDomesticStandingOrder3 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createDomesticStandingOrders($oBWriteDomesticStandingOrder3Param, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticStandingOrdersApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticStandingOrdersApi->new();
my $oBWriteDomesticStandingOrder3Param = WWW::SwaggerClient::Object::OBWriteDomesticStandingOrder3->new(); # OBWriteDomesticStandingOrder3 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createDomesticStandingOrders(oBWriteDomesticStandingOrder3Param => $oBWriteDomesticStandingOrder3Param, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrders: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticStandingOrdersApi()
oBWriteDomesticStandingOrder3Param =  # OBWriteDomesticStandingOrder3 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create Domestic Standing Orders
    api_response = api_instance.create_domestic_standing_orders(oBWriteDomesticStandingOrder3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrders: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBWriteDomesticStandingOrder3Param *

Responses

Status: 201 - Domestic Standing Orders Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getDomesticStandingOrderConsentsConsentId

Get Domestic Standing Order Consents


/domestic-standing-order-consents/{ConsentId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/domestic-standing-order-consents/{ConsentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.DomesticStandingOrdersApi;

import java.io.File;
import java.util.*;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticStandingOrderConsentResponse4 result = apiInstance.getDomesticStandingOrderConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#getDomesticStandingOrderConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.DomesticStandingOrdersApi;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticStandingOrderConsentResponse4 result = apiInstance.getDomesticStandingOrderConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#getDomesticStandingOrderConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

DomesticStandingOrdersApi *apiInstance = [[DomesticStandingOrdersApi alloc] init];

// Get Domestic Standing Order Consents
[apiInstance getDomesticStandingOrderConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteDomesticStandingOrderConsentResponse4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.DomesticStandingOrdersApi()

var consentId = consentId_example; // {String} ConsentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticStandingOrderConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticStandingOrderConsentsConsentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticStandingOrdersApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Domestic Standing Order Consents
                OBWriteDomesticStandingOrderConsentResponse4 result = apiInstance.getDomesticStandingOrderConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticStandingOrdersApi.getDomesticStandingOrderConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DomesticStandingOrdersApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getDomesticStandingOrderConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrderConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticStandingOrdersApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticStandingOrdersApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getDomesticStandingOrderConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrderConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticStandingOrdersApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Domestic Standing Order Consents
    api_response = api_instance.get_domestic_standing_order_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrderConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Domestic Standing Order Consents Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getDomesticStandingOrdersDomesticStandingOrderId

Get Domestic Standing Orders


/domestic-standing-orders/{DomesticStandingOrderId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/domestic-standing-orders/{DomesticStandingOrderId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.DomesticStandingOrdersApi;

import java.io.File;
import java.util.*;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        String domesticStandingOrderId = domesticStandingOrderId_example; // String | DomesticStandingOrderId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticStandingOrderResponse4 result = apiInstance.getDomesticStandingOrdersDomesticStandingOrderId(domesticStandingOrderId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#getDomesticStandingOrdersDomesticStandingOrderId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.DomesticStandingOrdersApi;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        String domesticStandingOrderId = domesticStandingOrderId_example; // String | DomesticStandingOrderId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteDomesticStandingOrderResponse4 result = apiInstance.getDomesticStandingOrdersDomesticStandingOrderId(domesticStandingOrderId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#getDomesticStandingOrdersDomesticStandingOrderId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *domesticStandingOrderId = domesticStandingOrderId_example; // DomesticStandingOrderId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

DomesticStandingOrdersApi *apiInstance = [[DomesticStandingOrdersApi alloc] init];

// Get Domestic Standing Orders
[apiInstance getDomesticStandingOrdersDomesticStandingOrderIdWith:domesticStandingOrderId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteDomesticStandingOrderResponse4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.DomesticStandingOrdersApi()

var domesticStandingOrderId = domesticStandingOrderId_example; // {String} DomesticStandingOrderId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticStandingOrdersDomesticStandingOrderId(domesticStandingOrderId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticStandingOrdersDomesticStandingOrderIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticStandingOrdersApi();
            var domesticStandingOrderId = domesticStandingOrderId_example;  // String | DomesticStandingOrderId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Domestic Standing Orders
                OBWriteDomesticStandingOrderResponse4 result = apiInstance.getDomesticStandingOrdersDomesticStandingOrderId(domesticStandingOrderId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticStandingOrdersApi.getDomesticStandingOrdersDomesticStandingOrderId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DomesticStandingOrdersApi();
$domesticStandingOrderId = domesticStandingOrderId_example; // String | DomesticStandingOrderId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getDomesticStandingOrdersDomesticStandingOrderId($domesticStandingOrderId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrdersDomesticStandingOrderId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticStandingOrdersApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticStandingOrdersApi->new();
my $domesticStandingOrderId = domesticStandingOrderId_example; # String | DomesticStandingOrderId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getDomesticStandingOrdersDomesticStandingOrderId(domesticStandingOrderId => $domesticStandingOrderId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrdersDomesticStandingOrderId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticStandingOrdersApi()
domesticStandingOrderId = domesticStandingOrderId_example # String | DomesticStandingOrderId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Domestic Standing Orders
    api_response = api_instance.get_domestic_standing_orders_domestic_standing_order_id(domesticStandingOrderId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrdersDomesticStandingOrderId: %s\n" % e)

Parameters

Path parameters
Name Description
DomesticStandingOrderId*
String
DomesticStandingOrderId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Domestic Standing Orders Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

EventNotification

createEventNotification

Send an event notification


/event-notifications

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/event-notifications"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.EventNotificationApi;

import java.io.File;
import java.util.*;

public class EventNotificationApiExample {

    public static void main(String[] args) {
        
        EventNotificationApi apiInstance = new EventNotificationApi();
        String oBEventNotification1Param = oBEventNotification1Param_example; // String | Create an Callback URI
        String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            apiInstance.createEventNotification(oBEventNotification1Param, xFapiFinancialId, xFapiInteractionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventNotificationApi#createEventNotification");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.EventNotificationApi;

public class EventNotificationApiExample {

    public static void main(String[] args) {
        EventNotificationApi apiInstance = new EventNotificationApi();
        String oBEventNotification1Param = oBEventNotification1Param_example; // String | Create an Callback URI
        String xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            apiInstance.createEventNotification(oBEventNotification1Param, xFapiFinancialId, xFapiInteractionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventNotificationApi#createEventNotification");
            e.printStackTrace();
        }
    }
}
String *oBEventNotification1Param = oBEventNotification1Param_example; // Create an Callback URI
String *xFapiFinancialId = xFapiFinancialId_example; // The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

EventNotificationApi *apiInstance = [[EventNotificationApi alloc] init];

// Send an event notification
[apiInstance createEventNotificationWith:oBEventNotification1Param
    xFapiFinancialId:xFapiFinancialId
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');

var api = new OpenBankingApi.EventNotificationApi()

var oBEventNotification1Param = oBEventNotification1Param_example; // {String} Create an Callback URI

var xFapiFinancialId = xFapiFinancialId_example; // {String} The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

var opts = { 
  'xFapiInteractionId': xFapiInteractionId_example // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createEventNotification(oBEventNotification1Param, xFapiFinancialId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createEventNotificationExample
    {
        public void main()
        {
            
            var apiInstance = new EventNotificationApi();
            var oBEventNotification1Param = oBEventNotification1Param_example;  // String | Create an Callback URI
            var xFapiFinancialId = xFapiFinancialId_example;  // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Send an event notification
                apiInstance.createEventNotification(oBEventNotification1Param, xFapiFinancialId, xFapiInteractionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventNotificationApi.createEventNotification: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EventNotificationApi();
$oBEventNotification1Param = oBEventNotification1Param_example; // String | Create an Callback URI
$xFapiFinancialId = xFapiFinancialId_example; // String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $api_instance->createEventNotification($oBEventNotification1Param, $xFapiFinancialId, $xFapiInteractionId);
} catch (Exception $e) {
    echo 'Exception when calling EventNotificationApi->createEventNotification: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventNotificationApi;

my $api_instance = WWW::SwaggerClient::EventNotificationApi->new();
my $oBEventNotification1Param = WWW::SwaggerClient::Object::String->new(); # String | Create an Callback URI
my $xFapiFinancialId = xFapiFinancialId_example; # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    $api_instance->createEventNotification(oBEventNotification1Param => $oBEventNotification1Param, xFapiFinancialId => $xFapiFinancialId, xFapiInteractionId => $xFapiInteractionId);
};
if ($@) {
    warn "Exception when calling EventNotificationApi->createEventNotification: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.EventNotificationApi()
oBEventNotification1Param = oBEventNotification1Param_example # String | Create an Callback URI
xFapiFinancialId = xFapiFinancialId_example # String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Send an event notification
    api_instance.create_event_notification(oBEventNotification1Param, xFapiFinancialId, xFapiInteractionId=xFapiInteractionId)
except ApiException as e:
    print("Exception when calling EventNotificationApi->createEventNotification: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-financial-id*
String
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
Required
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Body parameters
Name Description
oBEventNotification1Param *

Responses

Status: 202 - Accepted


EventSubscriptions

changeEventSubscriptionsEventSubscriptionId

Change Event Subscription


/event-subscriptions/{EventSubscriptionId}

Usage and SDK Samples

curl -X PUT "https://localhost:8080/open-banking/v2.3/event-subscriptions/{EventSubscriptionId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.EventSubscriptionsApi;

import java.io.File;
import java.util.*;

public class EventSubscriptionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        EventSubscriptionsApi apiInstance = new EventSubscriptionsApi();
        OBEventSubscriptionResponse1 oBEventSubscriptionResponse1Param = ; // OBEventSubscriptionResponse1 | Default
        String eventSubscriptionId = eventSubscriptionId_example; // String | EventSubscriptionId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBEventSubscriptionResponse1 result = apiInstance.changeEventSubscriptionsEventSubscriptionId(oBEventSubscriptionResponse1Param, eventSubscriptionId, authorization, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventSubscriptionsApi#changeEventSubscriptionsEventSubscriptionId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.EventSubscriptionsApi;

public class EventSubscriptionsApiExample {

    public static void main(String[] args) {
        EventSubscriptionsApi apiInstance = new EventSubscriptionsApi();
        OBEventSubscriptionResponse1 oBEventSubscriptionResponse1Param = ; // OBEventSubscriptionResponse1 | Default
        String eventSubscriptionId = eventSubscriptionId_example; // String | EventSubscriptionId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBEventSubscriptionResponse1 result = apiInstance.changeEventSubscriptionsEventSubscriptionId(oBEventSubscriptionResponse1Param, eventSubscriptionId, authorization, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventSubscriptionsApi#changeEventSubscriptionsEventSubscriptionId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBEventSubscriptionResponse1 *oBEventSubscriptionResponse1Param = ; // Default
String *eventSubscriptionId = eventSubscriptionId_example; // EventSubscriptionId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

EventSubscriptionsApi *apiInstance = [[EventSubscriptionsApi alloc] init];

// Change Event Subscription
[apiInstance changeEventSubscriptionsEventSubscriptionIdWith:oBEventSubscriptionResponse1Param
    eventSubscriptionId:eventSubscriptionId
    authorization:authorization
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBEventSubscriptionResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.EventSubscriptionsApi()

var oBEventSubscriptionResponse1Param = ; // {OBEventSubscriptionResponse1} Default

var eventSubscriptionId = eventSubscriptionId_example; // {String} EventSubscriptionId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.changeEventSubscriptionsEventSubscriptionId(oBEventSubscriptionResponse1Param, eventSubscriptionId, authorizationxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class changeEventSubscriptionsEventSubscriptionIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EventSubscriptionsApi();
            var oBEventSubscriptionResponse1Param = new OBEventSubscriptionResponse1(); // OBEventSubscriptionResponse1 | Default
            var eventSubscriptionId = eventSubscriptionId_example;  // String | EventSubscriptionId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Change Event Subscription
                OBEventSubscriptionResponse1 result = apiInstance.changeEventSubscriptionsEventSubscriptionId(oBEventSubscriptionResponse1Param, eventSubscriptionId, authorization, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventSubscriptionsApi.changeEventSubscriptionsEventSubscriptionId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\EventSubscriptionsApi();
$oBEventSubscriptionResponse1Param = ; // OBEventSubscriptionResponse1 | Default
$eventSubscriptionId = eventSubscriptionId_example; // String | EventSubscriptionId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->changeEventSubscriptionsEventSubscriptionId($oBEventSubscriptionResponse1Param, $eventSubscriptionId, $authorization, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventSubscriptionsApi->changeEventSubscriptionsEventSubscriptionId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventSubscriptionsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EventSubscriptionsApi->new();
my $oBEventSubscriptionResponse1Param = WWW::SwaggerClient::Object::OBEventSubscriptionResponse1->new(); # OBEventSubscriptionResponse1 | Default
my $eventSubscriptionId = eventSubscriptionId_example; # String | EventSubscriptionId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->changeEventSubscriptionsEventSubscriptionId(oBEventSubscriptionResponse1Param => $oBEventSubscriptionResponse1Param, eventSubscriptionId => $eventSubscriptionId, authorization => $authorization, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventSubscriptionsApi->changeEventSubscriptionsEventSubscriptionId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EventSubscriptionsApi()
oBEventSubscriptionResponse1Param =  # OBEventSubscriptionResponse1 | Default
eventSubscriptionId = eventSubscriptionId_example # String | EventSubscriptionId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Change Event Subscription
    api_response = api_instance.change_event_subscriptions_event_subscription_id(oBEventSubscriptionResponse1Param, eventSubscriptionId, authorization, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventSubscriptionsApi->changeEventSubscriptionsEventSubscriptionId: %s\n" % e)

Parameters

Path parameters
Name Description
EventSubscriptionId*
String
EventSubscriptionId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBEventSubscriptionResponse1Param *

Responses

Status: 200 - Event Subscription Changed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

createEventSubscriptions

Create Event Subscription


/event-subscriptions

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/event-subscriptions"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.EventSubscriptionsApi;

import java.io.File;
import java.util.*;

public class EventSubscriptionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        EventSubscriptionsApi apiInstance = new EventSubscriptionsApi();
        OBEventSubscription1 oBEventSubscription1Param = ; // OBEventSubscription1 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBEventSubscriptionResponse1 result = apiInstance.createEventSubscriptions(oBEventSubscription1Param, authorization, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventSubscriptionsApi#createEventSubscriptions");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.EventSubscriptionsApi;

public class EventSubscriptionsApiExample {

    public static void main(String[] args) {
        EventSubscriptionsApi apiInstance = new EventSubscriptionsApi();
        OBEventSubscription1 oBEventSubscription1Param = ; // OBEventSubscription1 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBEventSubscriptionResponse1 result = apiInstance.createEventSubscriptions(oBEventSubscription1Param, authorization, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventSubscriptionsApi#createEventSubscriptions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBEventSubscription1 *oBEventSubscription1Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

EventSubscriptionsApi *apiInstance = [[EventSubscriptionsApi alloc] init];

// Create Event Subscription
[apiInstance createEventSubscriptionsWith:oBEventSubscription1Param
    authorization:authorization
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBEventSubscriptionResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.EventSubscriptionsApi()

var oBEventSubscription1Param = ; // {OBEventSubscription1} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createEventSubscriptions(oBEventSubscription1Param, authorizationxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createEventSubscriptionsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EventSubscriptionsApi();
            var oBEventSubscription1Param = new OBEventSubscription1(); // OBEventSubscription1 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create Event Subscription
                OBEventSubscriptionResponse1 result = apiInstance.createEventSubscriptions(oBEventSubscription1Param, authorization, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventSubscriptionsApi.createEventSubscriptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\EventSubscriptionsApi();
$oBEventSubscription1Param = ; // OBEventSubscription1 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createEventSubscriptions($oBEventSubscription1Param, $authorization, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventSubscriptionsApi->createEventSubscriptions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventSubscriptionsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EventSubscriptionsApi->new();
my $oBEventSubscription1Param = WWW::SwaggerClient::Object::OBEventSubscription1->new(); # OBEventSubscription1 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createEventSubscriptions(oBEventSubscription1Param => $oBEventSubscription1Param, authorization => $authorization, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventSubscriptionsApi->createEventSubscriptions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EventSubscriptionsApi()
oBEventSubscription1Param =  # OBEventSubscription1 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create Event Subscription
    api_response = api_instance.create_event_subscriptions(oBEventSubscription1Param, authorization, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventSubscriptionsApi->createEventSubscriptions: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBEventSubscription1Param *

Responses

Status: 201 - Event Subscription Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

deleteEventSubscriptionsEventSubscriptionId

Delete Event Subscription


/event-subscriptions/{EventSubscriptionId}

Usage and SDK Samples

curl -X DELETE "https://localhost:8080/open-banking/v2.3/event-subscriptions/{EventSubscriptionId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.EventSubscriptionsApi;

import java.io.File;
import java.util.*;

public class EventSubscriptionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        EventSubscriptionsApi apiInstance = new EventSubscriptionsApi();
        String eventSubscriptionId = eventSubscriptionId_example; // String | EventSubscriptionId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            apiInstance.deleteEventSubscriptionsEventSubscriptionId(eventSubscriptionId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventSubscriptionsApi#deleteEventSubscriptionsEventSubscriptionId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.EventSubscriptionsApi;

public class EventSubscriptionsApiExample {

    public static void main(String[] args) {
        EventSubscriptionsApi apiInstance = new EventSubscriptionsApi();
        String eventSubscriptionId = eventSubscriptionId_example; // String | EventSubscriptionId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            apiInstance.deleteEventSubscriptionsEventSubscriptionId(eventSubscriptionId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventSubscriptionsApi#deleteEventSubscriptionsEventSubscriptionId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *eventSubscriptionId = eventSubscriptionId_example; // EventSubscriptionId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

EventSubscriptionsApi *apiInstance = [[EventSubscriptionsApi alloc] init];

// Delete Event Subscription
[apiInstance deleteEventSubscriptionsEventSubscriptionIdWith:eventSubscriptionId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.EventSubscriptionsApi()

var eventSubscriptionId = eventSubscriptionId_example; // {String} EventSubscriptionId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteEventSubscriptionsEventSubscriptionId(eventSubscriptionId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteEventSubscriptionsEventSubscriptionIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EventSubscriptionsApi();
            var eventSubscriptionId = eventSubscriptionId_example;  // String | EventSubscriptionId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Delete Event Subscription
                apiInstance.deleteEventSubscriptionsEventSubscriptionId(eventSubscriptionId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventSubscriptionsApi.deleteEventSubscriptionsEventSubscriptionId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\EventSubscriptionsApi();
$eventSubscriptionId = eventSubscriptionId_example; // String | EventSubscriptionId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $api_instance->deleteEventSubscriptionsEventSubscriptionId($eventSubscriptionId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
} catch (Exception $e) {
    echo 'Exception when calling EventSubscriptionsApi->deleteEventSubscriptionsEventSubscriptionId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventSubscriptionsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EventSubscriptionsApi->new();
my $eventSubscriptionId = eventSubscriptionId_example; # String | EventSubscriptionId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    $api_instance->deleteEventSubscriptionsEventSubscriptionId(eventSubscriptionId => $eventSubscriptionId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
};
if ($@) {
    warn "Exception when calling EventSubscriptionsApi->deleteEventSubscriptionsEventSubscriptionId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EventSubscriptionsApi()
eventSubscriptionId = eventSubscriptionId_example # String | EventSubscriptionId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Delete Event Subscription
    api_instance.delete_event_subscriptions_event_subscription_id(eventSubscriptionId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
except ApiException as e:
    print("Exception when calling EventSubscriptionsApi->deleteEventSubscriptionsEventSubscriptionId: %s\n" % e)

Parameters

Path parameters
Name Description
EventSubscriptionId*
String
EventSubscriptionId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 204 - Event Subscription Deleted

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getEventSubscriptions

Get Event Subscription


/event-subscriptions

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/event-subscriptions"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.EventSubscriptionsApi;

import java.io.File;
import java.util.*;

public class EventSubscriptionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        EventSubscriptionsApi apiInstance = new EventSubscriptionsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBEventSubscriptionsResponse1 result = apiInstance.getEventSubscriptions(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventSubscriptionsApi#getEventSubscriptions");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.EventSubscriptionsApi;

public class EventSubscriptionsApiExample {

    public static void main(String[] args) {
        EventSubscriptionsApi apiInstance = new EventSubscriptionsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBEventSubscriptionsResponse1 result = apiInstance.getEventSubscriptions(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventSubscriptionsApi#getEventSubscriptions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

EventSubscriptionsApi *apiInstance = [[EventSubscriptionsApi alloc] init];

// Get Event Subscription
[apiInstance getEventSubscriptionsWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBEventSubscriptionsResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.EventSubscriptionsApi()

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEventSubscriptions(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEventSubscriptionsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EventSubscriptionsApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Event Subscription
                OBEventSubscriptionsResponse1 result = apiInstance.getEventSubscriptions(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventSubscriptionsApi.getEventSubscriptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\EventSubscriptionsApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getEventSubscriptions($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventSubscriptionsApi->getEventSubscriptions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventSubscriptionsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EventSubscriptionsApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getEventSubscriptions(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventSubscriptionsApi->getEventSubscriptions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EventSubscriptionsApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Event Subscription
    api_response = api_instance.get_event_subscriptions(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventSubscriptionsApi->getEventSubscriptions: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Event Subscription Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Events

createEvents

Create Events


/events

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/events"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.EventsApi;

import java.io.File;
import java.util.*;

public class EventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        EventsApi apiInstance = new EventsApi();
        OBEventPolling1 oBEventPolling1Param = ; // OBEventPolling1 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBEventPollingResponse1 result = apiInstance.createEvents(oBEventPolling1Param, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#createEvents");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        OBEventPolling1 oBEventPolling1Param = ; // OBEventPolling1 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBEventPollingResponse1 result = apiInstance.createEvents(oBEventPolling1Param, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#createEvents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBEventPolling1 *oBEventPolling1Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

EventsApi *apiInstance = [[EventsApi alloc] init];

// Create Events
[apiInstance createEventsWith:oBEventPolling1Param
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBEventPollingResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.EventsApi()

var oBEventPolling1Param = ; // {OBEventPolling1} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createEvents(oBEventPolling1Param, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createEventsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EventsApi();
            var oBEventPolling1Param = new OBEventPolling1(); // OBEventPolling1 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create Events
                OBEventPollingResponse1 result = apiInstance.createEvents(oBEventPolling1Param, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.createEvents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\EventsApi();
$oBEventPolling1Param = ; // OBEventPolling1 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createEvents($oBEventPolling1Param, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->createEvents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EventsApi->new();
my $oBEventPolling1Param = WWW::SwaggerClient::Object::OBEventPolling1->new(); # OBEventPolling1 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createEvents(oBEventPolling1Param => $oBEventPolling1Param, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventsApi->createEvents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EventsApi()
oBEventPolling1Param =  # OBEventPolling1 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create Events
    api_response = api_instance.create_events(oBEventPolling1Param, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->createEvents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
Body parameters
Name Description
oBEventPolling1Param *

Responses

Status: 201 - Events Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

FilePayments

createFilePaymentConsents

Create File Payment Consents


/file-payment-consents

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/file-payment-consents"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.FilePaymentsApi;

import java.io.File;
import java.util.*;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        FilePaymentsApi apiInstance = new FilePaymentsApi();
        OBWriteFileConsent3 oBWriteFileConsent3Param = ; // OBWriteFileConsent3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteFileConsentResponse3 result = apiInstance.createFilePaymentConsents(oBWriteFileConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#createFilePaymentConsents");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.FilePaymentsApi;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        FilePaymentsApi apiInstance = new FilePaymentsApi();
        OBWriteFileConsent3 oBWriteFileConsent3Param = ; // OBWriteFileConsent3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteFileConsentResponse3 result = apiInstance.createFilePaymentConsents(oBWriteFileConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#createFilePaymentConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteFileConsent3 *oBWriteFileConsent3Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

FilePaymentsApi *apiInstance = [[FilePaymentsApi alloc] init];

// Create File Payment Consents
[apiInstance createFilePaymentConsentsWith:oBWriteFileConsent3Param
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteFileConsentResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.FilePaymentsApi()

var oBWriteFileConsent3Param = ; // {OBWriteFileConsent3} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.


var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFilePaymentConsents(oBWriteFileConsent3Param, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFilePaymentConsentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FilePaymentsApi();
            var oBWriteFileConsent3Param = new OBWriteFileConsent3(); // OBWriteFileConsent3 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create File Payment Consents
                OBWriteFileConsentResponse3 result = apiInstance.createFilePaymentConsents(oBWriteFileConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FilePaymentsApi.createFilePaymentConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\FilePaymentsApi();
$oBWriteFileConsent3Param = ; // OBWriteFileConsent3 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createFilePaymentConsents($oBWriteFileConsent3Param, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilePaymentsApi->createFilePaymentConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FilePaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FilePaymentsApi->new();
my $oBWriteFileConsent3Param = WWW::SwaggerClient::Object::OBWriteFileConsent3->new(); # OBWriteFileConsent3 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createFilePaymentConsents(oBWriteFileConsent3Param => $oBWriteFileConsent3Param, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilePaymentsApi->createFilePaymentConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FilePaymentsApi()
oBWriteFileConsent3Param =  # OBWriteFileConsent3 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create File Payment Consents
    api_response = api_instance.create_file_payment_consents(oBWriteFileConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilePaymentsApi->createFilePaymentConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBWriteFileConsent3Param *

Responses

Status: 201 - File Payment Consents Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

createFilePaymentConsentsConsentIdFile

Create File Payment Consents


/file-payment-consents/{ConsentId}/file

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/file-payment-consents/{ConsentId}/file"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.FilePaymentsApi;

import java.io.File;
import java.util.*;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        FilePaymentsApi apiInstance = new FilePaymentsApi();
        File fileParam = ; // File | Default
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            apiInstance.createFilePaymentConsentsConsentIdFile(fileParam, consentId, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#createFilePaymentConsentsConsentIdFile");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.FilePaymentsApi;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        FilePaymentsApi apiInstance = new FilePaymentsApi();
        File fileParam = ; // File | Default
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            apiInstance.createFilePaymentConsentsConsentIdFile(fileParam, consentId, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#createFilePaymentConsentsConsentIdFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

File *fileParam = ; // Default
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

FilePaymentsApi *apiInstance = [[FilePaymentsApi alloc] init];

// Create File Payment Consents
[apiInstance createFilePaymentConsentsConsentIdFileWith:fileParam
    consentId:consentId
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.FilePaymentsApi()

var fileParam = ; // {File} Default

var consentId = consentId_example; // {String} ConsentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.


var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createFilePaymentConsentsConsentIdFile(fileParam, consentId, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFilePaymentConsentsConsentIdFileExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FilePaymentsApi();
            var fileParam = new File(); // File | Default
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create File Payment Consents
                apiInstance.createFilePaymentConsentsConsentIdFile(fileParam, consentId, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FilePaymentsApi.createFilePaymentConsentsConsentIdFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\FilePaymentsApi();
$fileParam = ; // File | Default
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $api_instance->createFilePaymentConsentsConsentIdFile($fileParam, $consentId, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
} catch (Exception $e) {
    echo 'Exception when calling FilePaymentsApi->createFilePaymentConsentsConsentIdFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FilePaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FilePaymentsApi->new();
my $fileParam = WWW::SwaggerClient::Object::File->new(); # File | Default
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    $api_instance->createFilePaymentConsentsConsentIdFile(fileParam => $fileParam, consentId => $consentId, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
};
if ($@) {
    warn "Exception when calling FilePaymentsApi->createFilePaymentConsentsConsentIdFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FilePaymentsApi()
fileParam =  # File | Default
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create File Payment Consents
    api_instance.create_file_payment_consents_consent_id_file(fileParam, consentId, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
except ApiException as e:
    print("Exception when calling FilePaymentsApi->createFilePaymentConsentsConsentIdFile: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
fileParam *

Responses

Status: 200 - File Payment Consents Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

createFilePayments

Create File Payments


/file-payments

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/file-payments"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.FilePaymentsApi;

import java.io.File;
import java.util.*;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        FilePaymentsApi apiInstance = new FilePaymentsApi();
        OBWriteFile2 oBWriteFile2Param = ; // OBWriteFile2 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteFileResponse2 result = apiInstance.createFilePayments(oBWriteFile2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#createFilePayments");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.FilePaymentsApi;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        FilePaymentsApi apiInstance = new FilePaymentsApi();
        OBWriteFile2 oBWriteFile2Param = ; // OBWriteFile2 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteFileResponse2 result = apiInstance.createFilePayments(oBWriteFile2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#createFilePayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteFile2 *oBWriteFile2Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

FilePaymentsApi *apiInstance = [[FilePaymentsApi alloc] init];

// Create File Payments
[apiInstance createFilePaymentsWith:oBWriteFile2Param
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteFileResponse2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.FilePaymentsApi()

var oBWriteFile2Param = ; // {OBWriteFile2} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.


var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFilePayments(oBWriteFile2Param, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFilePaymentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FilePaymentsApi();
            var oBWriteFile2Param = new OBWriteFile2(); // OBWriteFile2 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create File Payments
                OBWriteFileResponse2 result = apiInstance.createFilePayments(oBWriteFile2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FilePaymentsApi.createFilePayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\FilePaymentsApi();
$oBWriteFile2Param = ; // OBWriteFile2 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createFilePayments($oBWriteFile2Param, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilePaymentsApi->createFilePayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FilePaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FilePaymentsApi->new();
my $oBWriteFile2Param = WWW::SwaggerClient::Object::OBWriteFile2->new(); # OBWriteFile2 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createFilePayments(oBWriteFile2Param => $oBWriteFile2Param, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilePaymentsApi->createFilePayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FilePaymentsApi()
oBWriteFile2Param =  # OBWriteFile2 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create File Payments
    api_response = api_instance.create_file_payments(oBWriteFile2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilePaymentsApi->createFilePayments: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBWriteFile2Param *

Responses

Status: 201 - File Payments Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getFilePaymentConsentsConsentId

Get File Payment Consents


/file-payment-consents/{ConsentId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/file-payment-consents/{ConsentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.FilePaymentsApi;

import java.io.File;
import java.util.*;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        FilePaymentsApi apiInstance = new FilePaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteFileConsentResponse3 result = apiInstance.getFilePaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#getFilePaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.FilePaymentsApi;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        FilePaymentsApi apiInstance = new FilePaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteFileConsentResponse3 result = apiInstance.getFilePaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#getFilePaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

FilePaymentsApi *apiInstance = [[FilePaymentsApi alloc] init];

// Get File Payment Consents
[apiInstance getFilePaymentConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteFileConsentResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.FilePaymentsApi()

var consentId = consentId_example; // {String} ConsentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFilePaymentConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFilePaymentConsentsConsentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FilePaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get File Payment Consents
                OBWriteFileConsentResponse3 result = apiInstance.getFilePaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FilePaymentsApi.getFilePaymentConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\FilePaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getFilePaymentConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilePaymentsApi->getFilePaymentConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FilePaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FilePaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getFilePaymentConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilePaymentsApi->getFilePaymentConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FilePaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get File Payment Consents
    api_response = api_instance.get_file_payment_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilePaymentsApi->getFilePaymentConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - File Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getFilePaymentConsentsConsentIdFile

Get File Payment Consents


/file-payment-consents/{ConsentId}/file

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/file-payment-consents/{ConsentId}/file"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.FilePaymentsApi;

import java.io.File;
import java.util.*;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        FilePaymentsApi apiInstance = new FilePaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            File result = apiInstance.getFilePaymentConsentsConsentIdFile(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#getFilePaymentConsentsConsentIdFile");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.FilePaymentsApi;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        FilePaymentsApi apiInstance = new FilePaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            File result = apiInstance.getFilePaymentConsentsConsentIdFile(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#getFilePaymentConsentsConsentIdFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

FilePaymentsApi *apiInstance = [[FilePaymentsApi alloc] init];

// Get File Payment Consents
[apiInstance getFilePaymentConsentsConsentIdFileWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(File output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.FilePaymentsApi()

var consentId = consentId_example; // {String} ConsentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFilePaymentConsentsConsentIdFile(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFilePaymentConsentsConsentIdFileExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FilePaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get File Payment Consents
                File result = apiInstance.getFilePaymentConsentsConsentIdFile(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FilePaymentsApi.getFilePaymentConsentsConsentIdFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\FilePaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getFilePaymentConsentsConsentIdFile($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilePaymentsApi->getFilePaymentConsentsConsentIdFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FilePaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FilePaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getFilePaymentConsentsConsentIdFile(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilePaymentsApi->getFilePaymentConsentsConsentIdFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FilePaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get File Payment Consents
    api_response = api_instance.get_file_payment_consents_consent_id_file(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilePaymentsApi->getFilePaymentConsentsConsentIdFile: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - File Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getFilePaymentsFilePaymentId

Get File Payments


/file-payments/{FilePaymentId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/file-payments/{FilePaymentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.FilePaymentsApi;

import java.io.File;
import java.util.*;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        FilePaymentsApi apiInstance = new FilePaymentsApi();
        String filePaymentId = filePaymentId_example; // String | FilePaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteFileResponse2 result = apiInstance.getFilePaymentsFilePaymentId(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#getFilePaymentsFilePaymentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.FilePaymentsApi;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        FilePaymentsApi apiInstance = new FilePaymentsApi();
        String filePaymentId = filePaymentId_example; // String | FilePaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteFileResponse2 result = apiInstance.getFilePaymentsFilePaymentId(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#getFilePaymentsFilePaymentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *filePaymentId = filePaymentId_example; // FilePaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

FilePaymentsApi *apiInstance = [[FilePaymentsApi alloc] init];

// Get File Payments
[apiInstance getFilePaymentsFilePaymentIdWith:filePaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteFileResponse2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.FilePaymentsApi()

var filePaymentId = filePaymentId_example; // {String} FilePaymentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFilePaymentsFilePaymentId(filePaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFilePaymentsFilePaymentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FilePaymentsApi();
            var filePaymentId = filePaymentId_example;  // String | FilePaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get File Payments
                OBWriteFileResponse2 result = apiInstance.getFilePaymentsFilePaymentId(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FilePaymentsApi.getFilePaymentsFilePaymentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\FilePaymentsApi();
$filePaymentId = filePaymentId_example; // String | FilePaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getFilePaymentsFilePaymentId($filePaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilePaymentsApi->getFilePaymentsFilePaymentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FilePaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FilePaymentsApi->new();
my $filePaymentId = filePaymentId_example; # String | FilePaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getFilePaymentsFilePaymentId(filePaymentId => $filePaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilePaymentsApi->getFilePaymentsFilePaymentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FilePaymentsApi()
filePaymentId = filePaymentId_example # String | FilePaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get File Payments
    api_response = api_instance.get_file_payments_file_payment_id(filePaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilePaymentsApi->getFilePaymentsFilePaymentId: %s\n" % e)

Parameters

Path parameters
Name Description
FilePaymentId*
String
FilePaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - File Payments Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getFilePaymentsFilePaymentIdReportFile

Get File Payments


/file-payments/{FilePaymentId}/report-file

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/file-payments/{FilePaymentId}/report-file"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.FilePaymentsApi;

import java.io.File;
import java.util.*;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        FilePaymentsApi apiInstance = new FilePaymentsApi();
        String filePaymentId = filePaymentId_example; // String | FilePaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            File result = apiInstance.getFilePaymentsFilePaymentIdReportFile(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#getFilePaymentsFilePaymentIdReportFile");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.FilePaymentsApi;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        FilePaymentsApi apiInstance = new FilePaymentsApi();
        String filePaymentId = filePaymentId_example; // String | FilePaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            File result = apiInstance.getFilePaymentsFilePaymentIdReportFile(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#getFilePaymentsFilePaymentIdReportFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *filePaymentId = filePaymentId_example; // FilePaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

FilePaymentsApi *apiInstance = [[FilePaymentsApi alloc] init];

// Get File Payments
[apiInstance getFilePaymentsFilePaymentIdReportFileWith:filePaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(File output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.FilePaymentsApi()

var filePaymentId = filePaymentId_example; // {String} FilePaymentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFilePaymentsFilePaymentIdReportFile(filePaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFilePaymentsFilePaymentIdReportFileExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FilePaymentsApi();
            var filePaymentId = filePaymentId_example;  // String | FilePaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get File Payments
                File result = apiInstance.getFilePaymentsFilePaymentIdReportFile(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FilePaymentsApi.getFilePaymentsFilePaymentIdReportFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\FilePaymentsApi();
$filePaymentId = filePaymentId_example; // String | FilePaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getFilePaymentsFilePaymentIdReportFile($filePaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilePaymentsApi->getFilePaymentsFilePaymentIdReportFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FilePaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FilePaymentsApi->new();
my $filePaymentId = filePaymentId_example; # String | FilePaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getFilePaymentsFilePaymentIdReportFile(filePaymentId => $filePaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilePaymentsApi->getFilePaymentsFilePaymentIdReportFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FilePaymentsApi()
filePaymentId = filePaymentId_example # String | FilePaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get File Payments
    api_response = api_instance.get_file_payments_file_payment_id_report_file(filePaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilePaymentsApi->getFilePaymentsFilePaymentIdReportFile: %s\n" % e)

Parameters

Path parameters
Name Description
FilePaymentId*
String
FilePaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - File Payments Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

FundsConfirmations

createFundsConfirmationConsents

Create Funds Confirmation Consent


/funds-confirmation-consents

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/funds-confirmation-consents"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.FundsConfirmationsApi;

import java.io.File;
import java.util.*;

public class FundsConfirmationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        FundsConfirmationsApi apiInstance = new FundsConfirmationsApi();
        OBFundsConfirmationConsent1 oBFundsConfirmationConsent1Param = ; // OBFundsConfirmationConsent1 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBFundsConfirmationConsentResponse1 result = apiInstance.createFundsConfirmationConsents(oBFundsConfirmationConsent1Param, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FundsConfirmationsApi#createFundsConfirmationConsents");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.FundsConfirmationsApi;

public class FundsConfirmationsApiExample {

    public static void main(String[] args) {
        FundsConfirmationsApi apiInstance = new FundsConfirmationsApi();
        OBFundsConfirmationConsent1 oBFundsConfirmationConsent1Param = ; // OBFundsConfirmationConsent1 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBFundsConfirmationConsentResponse1 result = apiInstance.createFundsConfirmationConsents(oBFundsConfirmationConsent1Param, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FundsConfirmationsApi#createFundsConfirmationConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBFundsConfirmationConsent1 *oBFundsConfirmationConsent1Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

FundsConfirmationsApi *apiInstance = [[FundsConfirmationsApi alloc] init];

// Create Funds Confirmation Consent
[apiInstance createFundsConfirmationConsentsWith:oBFundsConfirmationConsent1Param
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBFundsConfirmationConsentResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.FundsConfirmationsApi()

var oBFundsConfirmationConsent1Param = ; // {OBFundsConfirmationConsent1} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFundsConfirmationConsents(oBFundsConfirmationConsent1Param, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFundsConfirmationConsentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FundsConfirmationsApi();
            var oBFundsConfirmationConsent1Param = new OBFundsConfirmationConsent1(); // OBFundsConfirmationConsent1 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create Funds Confirmation Consent
                OBFundsConfirmationConsentResponse1 result = apiInstance.createFundsConfirmationConsents(oBFundsConfirmationConsent1Param, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FundsConfirmationsApi.createFundsConfirmationConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\FundsConfirmationsApi();
$oBFundsConfirmationConsent1Param = ; // OBFundsConfirmationConsent1 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createFundsConfirmationConsents($oBFundsConfirmationConsent1Param, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FundsConfirmationsApi->createFundsConfirmationConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FundsConfirmationsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FundsConfirmationsApi->new();
my $oBFundsConfirmationConsent1Param = WWW::SwaggerClient::Object::OBFundsConfirmationConsent1->new(); # OBFundsConfirmationConsent1 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createFundsConfirmationConsents(oBFundsConfirmationConsent1Param => $oBFundsConfirmationConsent1Param, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FundsConfirmationsApi->createFundsConfirmationConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FundsConfirmationsApi()
oBFundsConfirmationConsent1Param =  # OBFundsConfirmationConsent1 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create Funds Confirmation Consent
    api_response = api_instance.create_funds_confirmation_consents(oBFundsConfirmationConsent1Param, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FundsConfirmationsApi->createFundsConfirmationConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
Body parameters
Name Description
oBFundsConfirmationConsent1Param *

Responses

Status: 201 - Funds Confirmation Consent Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

createFundsConfirmations

Create Funds Confirmation


/funds-confirmations

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/funds-confirmations"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.FundsConfirmationsApi;

import java.io.File;
import java.util.*;

public class FundsConfirmationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        FundsConfirmationsApi apiInstance = new FundsConfirmationsApi();
        OBFundsConfirmation1 oBFundsConfirmation1Param = ; // OBFundsConfirmation1 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBFundsConfirmationResponse1 result = apiInstance.createFundsConfirmations(oBFundsConfirmation1Param, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FundsConfirmationsApi#createFundsConfirmations");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.FundsConfirmationsApi;

public class FundsConfirmationsApiExample {

    public static void main(String[] args) {
        FundsConfirmationsApi apiInstance = new FundsConfirmationsApi();
        OBFundsConfirmation1 oBFundsConfirmation1Param = ; // OBFundsConfirmation1 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBFundsConfirmationResponse1 result = apiInstance.createFundsConfirmations(oBFundsConfirmation1Param, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FundsConfirmationsApi#createFundsConfirmations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBFundsConfirmation1 *oBFundsConfirmation1Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

FundsConfirmationsApi *apiInstance = [[FundsConfirmationsApi alloc] init];

// Create Funds Confirmation
[apiInstance createFundsConfirmationsWith:oBFundsConfirmation1Param
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBFundsConfirmationResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.FundsConfirmationsApi()

var oBFundsConfirmation1Param = ; // {OBFundsConfirmation1} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFundsConfirmations(oBFundsConfirmation1Param, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFundsConfirmationsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FundsConfirmationsApi();
            var oBFundsConfirmation1Param = new OBFundsConfirmation1(); // OBFundsConfirmation1 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create Funds Confirmation
                OBFundsConfirmationResponse1 result = apiInstance.createFundsConfirmations(oBFundsConfirmation1Param, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FundsConfirmationsApi.createFundsConfirmations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\FundsConfirmationsApi();
$oBFundsConfirmation1Param = ; // OBFundsConfirmation1 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createFundsConfirmations($oBFundsConfirmation1Param, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FundsConfirmationsApi->createFundsConfirmations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FundsConfirmationsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FundsConfirmationsApi->new();
my $oBFundsConfirmation1Param = WWW::SwaggerClient::Object::OBFundsConfirmation1->new(); # OBFundsConfirmation1 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createFundsConfirmations(oBFundsConfirmation1Param => $oBFundsConfirmation1Param, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FundsConfirmationsApi->createFundsConfirmations: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FundsConfirmationsApi()
oBFundsConfirmation1Param =  # OBFundsConfirmation1 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create Funds Confirmation
    api_response = api_instance.create_funds_confirmations(oBFundsConfirmation1Param, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FundsConfirmationsApi->createFundsConfirmations: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
Body parameters
Name Description
oBFundsConfirmation1Param *

Responses

Status: 201 - Funds Confirmation Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

deleteFundsConfirmationConsentsConsentId

Delete Funds Confirmation Consent


/funds-confirmation-consents/{ConsentId}

Usage and SDK Samples

curl -X DELETE "https://localhost:8080/open-banking/v2.3/funds-confirmation-consents/{ConsentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.FundsConfirmationsApi;

import java.io.File;
import java.util.*;

public class FundsConfirmationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        FundsConfirmationsApi apiInstance = new FundsConfirmationsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            apiInstance.deleteFundsConfirmationConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling FundsConfirmationsApi#deleteFundsConfirmationConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.FundsConfirmationsApi;

public class FundsConfirmationsApiExample {

    public static void main(String[] args) {
        FundsConfirmationsApi apiInstance = new FundsConfirmationsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            apiInstance.deleteFundsConfirmationConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling FundsConfirmationsApi#deleteFundsConfirmationConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

FundsConfirmationsApi *apiInstance = [[FundsConfirmationsApi alloc] init];

// Delete Funds Confirmation Consent
[apiInstance deleteFundsConfirmationConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.FundsConfirmationsApi()

var consentId = consentId_example; // {String} ConsentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteFundsConfirmationConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteFundsConfirmationConsentsConsentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FundsConfirmationsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Delete Funds Confirmation Consent
                apiInstance.deleteFundsConfirmationConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FundsConfirmationsApi.deleteFundsConfirmationConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\FundsConfirmationsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $api_instance->deleteFundsConfirmationConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
} catch (Exception $e) {
    echo 'Exception when calling FundsConfirmationsApi->deleteFundsConfirmationConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FundsConfirmationsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FundsConfirmationsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    $api_instance->deleteFundsConfirmationConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
};
if ($@) {
    warn "Exception when calling FundsConfirmationsApi->deleteFundsConfirmationConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FundsConfirmationsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Delete Funds Confirmation Consent
    api_instance.delete_funds_confirmation_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
except ApiException as e:
    print("Exception when calling FundsConfirmationsApi->deleteFundsConfirmationConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 204 - Funds Confirmation Consent Deleted

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getFundsConfirmationConsentsConsentId

Get Funds Confirmation Consent


/funds-confirmation-consents/{ConsentId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/funds-confirmation-consents/{ConsentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.FundsConfirmationsApi;

import java.io.File;
import java.util.*;

public class FundsConfirmationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        FundsConfirmationsApi apiInstance = new FundsConfirmationsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBFundsConfirmationConsentResponse1 result = apiInstance.getFundsConfirmationConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FundsConfirmationsApi#getFundsConfirmationConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.FundsConfirmationsApi;

public class FundsConfirmationsApiExample {

    public static void main(String[] args) {
        FundsConfirmationsApi apiInstance = new FundsConfirmationsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBFundsConfirmationConsentResponse1 result = apiInstance.getFundsConfirmationConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FundsConfirmationsApi#getFundsConfirmationConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

FundsConfirmationsApi *apiInstance = [[FundsConfirmationsApi alloc] init];

// Get Funds Confirmation Consent
[apiInstance getFundsConfirmationConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBFundsConfirmationConsentResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.FundsConfirmationsApi()

var consentId = consentId_example; // {String} ConsentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFundsConfirmationConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFundsConfirmationConsentsConsentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FundsConfirmationsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Funds Confirmation Consent
                OBFundsConfirmationConsentResponse1 result = apiInstance.getFundsConfirmationConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FundsConfirmationsApi.getFundsConfirmationConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\FundsConfirmationsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getFundsConfirmationConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FundsConfirmationsApi->getFundsConfirmationConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FundsConfirmationsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FundsConfirmationsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getFundsConfirmationConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FundsConfirmationsApi->getFundsConfirmationConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FundsConfirmationsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Funds Confirmation Consent
    api_response = api_instance.get_funds_confirmation_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FundsConfirmationsApi->getFundsConfirmationConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Funds Confirmation Consent Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

InternationalPayments

createInternationalPaymentConsents

Create International Payment Consents


/international-payment-consents

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/international-payment-consents"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.InternationalPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        OBWriteInternationalConsent3 oBWriteInternationalConsent3Param = ; // OBWriteInternationalConsent3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalConsentResponse3 result = apiInstance.createInternationalPaymentConsents(oBWriteInternationalConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#createInternationalPaymentConsents");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.InternationalPaymentsApi;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        OBWriteInternationalConsent3 oBWriteInternationalConsent3Param = ; // OBWriteInternationalConsent3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalConsentResponse3 result = apiInstance.createInternationalPaymentConsents(oBWriteInternationalConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#createInternationalPaymentConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteInternationalConsent3 *oBWriteInternationalConsent3Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

InternationalPaymentsApi *apiInstance = [[InternationalPaymentsApi alloc] init];

// Create International Payment Consents
[apiInstance createInternationalPaymentConsentsWith:oBWriteInternationalConsent3Param
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteInternationalConsentResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.InternationalPaymentsApi()

var oBWriteInternationalConsent3Param = ; // {OBWriteInternationalConsent3} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.


var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createInternationalPaymentConsents(oBWriteInternationalConsent3Param, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createInternationalPaymentConsentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalPaymentsApi();
            var oBWriteInternationalConsent3Param = new OBWriteInternationalConsent3(); // OBWriteInternationalConsent3 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create International Payment Consents
                OBWriteInternationalConsentResponse3 result = apiInstance.createInternationalPaymentConsents(oBWriteInternationalConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalPaymentsApi.createInternationalPaymentConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\InternationalPaymentsApi();
$oBWriteInternationalConsent3Param = ; // OBWriteInternationalConsent3 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createInternationalPaymentConsents($oBWriteInternationalConsent3Param, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalPaymentsApi->createInternationalPaymentConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalPaymentsApi->new();
my $oBWriteInternationalConsent3Param = WWW::SwaggerClient::Object::OBWriteInternationalConsent3->new(); # OBWriteInternationalConsent3 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createInternationalPaymentConsents(oBWriteInternationalConsent3Param => $oBWriteInternationalConsent3Param, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalPaymentsApi->createInternationalPaymentConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalPaymentsApi()
oBWriteInternationalConsent3Param =  # OBWriteInternationalConsent3 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create International Payment Consents
    api_response = api_instance.create_international_payment_consents(oBWriteInternationalConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalPaymentsApi->createInternationalPaymentConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBWriteInternationalConsent3Param *

Responses

Status: 201 - International Payment Consents Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

createInternationalPayments

Create International Payments


/international-payments

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/international-payments"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.InternationalPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        OBWriteInternational2 oBWriteInternational2Param = ; // OBWriteInternational2 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalResponse3 result = apiInstance.createInternationalPayments(oBWriteInternational2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#createInternationalPayments");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.InternationalPaymentsApi;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        OBWriteInternational2 oBWriteInternational2Param = ; // OBWriteInternational2 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalResponse3 result = apiInstance.createInternationalPayments(oBWriteInternational2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#createInternationalPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteInternational2 *oBWriteInternational2Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

InternationalPaymentsApi *apiInstance = [[InternationalPaymentsApi alloc] init];

// Create International Payments
[apiInstance createInternationalPaymentsWith:oBWriteInternational2Param
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteInternationalResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.InternationalPaymentsApi()

var oBWriteInternational2Param = ; // {OBWriteInternational2} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.


var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createInternationalPayments(oBWriteInternational2Param, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createInternationalPaymentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalPaymentsApi();
            var oBWriteInternational2Param = new OBWriteInternational2(); // OBWriteInternational2 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create International Payments
                OBWriteInternationalResponse3 result = apiInstance.createInternationalPayments(oBWriteInternational2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalPaymentsApi.createInternationalPayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\InternationalPaymentsApi();
$oBWriteInternational2Param = ; // OBWriteInternational2 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createInternationalPayments($oBWriteInternational2Param, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalPaymentsApi->createInternationalPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalPaymentsApi->new();
my $oBWriteInternational2Param = WWW::SwaggerClient::Object::OBWriteInternational2->new(); # OBWriteInternational2 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createInternationalPayments(oBWriteInternational2Param => $oBWriteInternational2Param, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalPaymentsApi->createInternationalPayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalPaymentsApi()
oBWriteInternational2Param =  # OBWriteInternational2 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create International Payments
    api_response = api_instance.create_international_payments(oBWriteInternational2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalPaymentsApi->createInternationalPayments: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBWriteInternational2Param *

Responses

Status: 201 - International Payments Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getInternationalPaymentConsentsConsentId

Get International Payment Consents


/international-payment-consents/{ConsentId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/international-payment-consents/{ConsentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.InternationalPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalConsentResponse3 result = apiInstance.getInternationalPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#getInternationalPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.InternationalPaymentsApi;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalConsentResponse3 result = apiInstance.getInternationalPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#getInternationalPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

InternationalPaymentsApi *apiInstance = [[InternationalPaymentsApi alloc] init];

// Get International Payment Consents
[apiInstance getInternationalPaymentConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteInternationalConsentResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.InternationalPaymentsApi()

var consentId = consentId_example; // {String} ConsentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalPaymentConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalPaymentConsentsConsentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get International Payment Consents
                OBWriteInternationalConsentResponse3 result = apiInstance.getInternationalPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalPaymentsApi.getInternationalPaymentConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\InternationalPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getInternationalPaymentConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalPaymentsApi->getInternationalPaymentConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getInternationalPaymentConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalPaymentsApi->getInternationalPaymentConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalPaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get International Payment Consents
    api_response = api_instance.get_international_payment_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalPaymentsApi->getInternationalPaymentConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - International Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getInternationalPaymentConsentsConsentIdFundsConfirmation

Get International Payment Consents


/international-payment-consents/{ConsentId}/funds-confirmation

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/international-payment-consents/{ConsentId}/funds-confirmation"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.InternationalPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteFundsConfirmationResponse1 result = apiInstance.getInternationalPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#getInternationalPaymentConsentsConsentIdFundsConfirmation");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.InternationalPaymentsApi;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteFundsConfirmationResponse1 result = apiInstance.getInternationalPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#getInternationalPaymentConsentsConsentIdFundsConfirmation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

InternationalPaymentsApi *apiInstance = [[InternationalPaymentsApi alloc] init];

// Get International Payment Consents
[apiInstance getInternationalPaymentConsentsConsentIdFundsConfirmationWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteFundsConfirmationResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.InternationalPaymentsApi()

var consentId = consentId_example; // {String} ConsentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalPaymentConsentsConsentIdFundsConfirmationExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get International Payment Consents
                OBWriteFundsConfirmationResponse1 result = apiInstance.getInternationalPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalPaymentsApi.getInternationalPaymentConsentsConsentIdFundsConfirmation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\InternationalPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getInternationalPaymentConsentsConsentIdFundsConfirmation($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalPaymentsApi->getInternationalPaymentConsentsConsentIdFundsConfirmation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getInternationalPaymentConsentsConsentIdFundsConfirmation(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalPaymentsApi->getInternationalPaymentConsentsConsentIdFundsConfirmation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalPaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get International Payment Consents
    api_response = api_instance.get_international_payment_consents_consent_id_funds_confirmation(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalPaymentsApi->getInternationalPaymentConsentsConsentIdFundsConfirmation: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - International Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getInternationalPaymentsInternationalPaymentId

Get International Payments


/international-payments/{InternationalPaymentId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/international-payments/{InternationalPaymentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.InternationalPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        String internationalPaymentId = internationalPaymentId_example; // String | InternationalPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalResponse3 result = apiInstance.getInternationalPaymentsInternationalPaymentId(internationalPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#getInternationalPaymentsInternationalPaymentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.InternationalPaymentsApi;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        String internationalPaymentId = internationalPaymentId_example; // String | InternationalPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalResponse3 result = apiInstance.getInternationalPaymentsInternationalPaymentId(internationalPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#getInternationalPaymentsInternationalPaymentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *internationalPaymentId = internationalPaymentId_example; // InternationalPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

InternationalPaymentsApi *apiInstance = [[InternationalPaymentsApi alloc] init];

// Get International Payments
[apiInstance getInternationalPaymentsInternationalPaymentIdWith:internationalPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteInternationalResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.InternationalPaymentsApi()

var internationalPaymentId = internationalPaymentId_example; // {String} InternationalPaymentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalPaymentsInternationalPaymentId(internationalPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalPaymentsInternationalPaymentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalPaymentsApi();
            var internationalPaymentId = internationalPaymentId_example;  // String | InternationalPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get International Payments
                OBWriteInternationalResponse3 result = apiInstance.getInternationalPaymentsInternationalPaymentId(internationalPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalPaymentsApi.getInternationalPaymentsInternationalPaymentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\InternationalPaymentsApi();
$internationalPaymentId = internationalPaymentId_example; // String | InternationalPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getInternationalPaymentsInternationalPaymentId($internationalPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalPaymentsApi->getInternationalPaymentsInternationalPaymentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalPaymentsApi->new();
my $internationalPaymentId = internationalPaymentId_example; # String | InternationalPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getInternationalPaymentsInternationalPaymentId(internationalPaymentId => $internationalPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalPaymentsApi->getInternationalPaymentsInternationalPaymentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalPaymentsApi()
internationalPaymentId = internationalPaymentId_example # String | InternationalPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get International Payments
    api_response = api_instance.get_international_payments_international_payment_id(internationalPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalPaymentsApi->getInternationalPaymentsInternationalPaymentId: %s\n" % e)

Parameters

Path parameters
Name Description
InternationalPaymentId*
String
InternationalPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - International Payments Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

InternationalScheduledPayments

createInternationalScheduledPaymentConsents

Create International Scheduled Payment Consents


/international-scheduled-payment-consents

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/international-scheduled-payment-consents"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.InternationalScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        OBWriteInternationalScheduledConsent3 oBWriteInternationalScheduledConsent3Param = ; // OBWriteInternationalScheduledConsent3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalScheduledConsentResponse3 result = apiInstance.createInternationalScheduledPaymentConsents(oBWriteInternationalScheduledConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#createInternationalScheduledPaymentConsents");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.InternationalScheduledPaymentsApi;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        OBWriteInternationalScheduledConsent3 oBWriteInternationalScheduledConsent3Param = ; // OBWriteInternationalScheduledConsent3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalScheduledConsentResponse3 result = apiInstance.createInternationalScheduledPaymentConsents(oBWriteInternationalScheduledConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#createInternationalScheduledPaymentConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteInternationalScheduledConsent3 *oBWriteInternationalScheduledConsent3Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

InternationalScheduledPaymentsApi *apiInstance = [[InternationalScheduledPaymentsApi alloc] init];

// Create International Scheduled Payment Consents
[apiInstance createInternationalScheduledPaymentConsentsWith:oBWriteInternationalScheduledConsent3Param
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteInternationalScheduledConsentResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.InternationalScheduledPaymentsApi()

var oBWriteInternationalScheduledConsent3Param = ; // {OBWriteInternationalScheduledConsent3} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.


var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createInternationalScheduledPaymentConsents(oBWriteInternationalScheduledConsent3Param, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createInternationalScheduledPaymentConsentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalScheduledPaymentsApi();
            var oBWriteInternationalScheduledConsent3Param = new OBWriteInternationalScheduledConsent3(); // OBWriteInternationalScheduledConsent3 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create International Scheduled Payment Consents
                OBWriteInternationalScheduledConsentResponse3 result = apiInstance.createInternationalScheduledPaymentConsents(oBWriteInternationalScheduledConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalScheduledPaymentsApi.createInternationalScheduledPaymentConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\InternationalScheduledPaymentsApi();
$oBWriteInternationalScheduledConsent3Param = ; // OBWriteInternationalScheduledConsent3 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createInternationalScheduledPaymentConsents($oBWriteInternationalScheduledConsent3Param, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalScheduledPaymentsApi->createInternationalScheduledPaymentConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalScheduledPaymentsApi->new();
my $oBWriteInternationalScheduledConsent3Param = WWW::SwaggerClient::Object::OBWriteInternationalScheduledConsent3->new(); # OBWriteInternationalScheduledConsent3 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createInternationalScheduledPaymentConsents(oBWriteInternationalScheduledConsent3Param => $oBWriteInternationalScheduledConsent3Param, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalScheduledPaymentsApi->createInternationalScheduledPaymentConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalScheduledPaymentsApi()
oBWriteInternationalScheduledConsent3Param =  # OBWriteInternationalScheduledConsent3 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create International Scheduled Payment Consents
    api_response = api_instance.create_international_scheduled_payment_consents(oBWriteInternationalScheduledConsent3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalScheduledPaymentsApi->createInternationalScheduledPaymentConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBWriteInternationalScheduledConsent3Param *

Responses

Status: 201 - International Scheduled Payment Consents Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

createInternationalScheduledPayments

Create International Scheduled Payments


/international-scheduled-payments

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/international-scheduled-payments"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.InternationalScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        OBWriteInternationalScheduled2 oBWriteInternationalScheduled2Param = ; // OBWriteInternationalScheduled2 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalScheduledResponse3 result = apiInstance.createInternationalScheduledPayments(oBWriteInternationalScheduled2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#createInternationalScheduledPayments");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.InternationalScheduledPaymentsApi;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        OBWriteInternationalScheduled2 oBWriteInternationalScheduled2Param = ; // OBWriteInternationalScheduled2 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalScheduledResponse3 result = apiInstance.createInternationalScheduledPayments(oBWriteInternationalScheduled2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#createInternationalScheduledPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteInternationalScheduled2 *oBWriteInternationalScheduled2Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

InternationalScheduledPaymentsApi *apiInstance = [[InternationalScheduledPaymentsApi alloc] init];

// Create International Scheduled Payments
[apiInstance createInternationalScheduledPaymentsWith:oBWriteInternationalScheduled2Param
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteInternationalScheduledResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.InternationalScheduledPaymentsApi()

var oBWriteInternationalScheduled2Param = ; // {OBWriteInternationalScheduled2} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.


var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createInternationalScheduledPayments(oBWriteInternationalScheduled2Param, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createInternationalScheduledPaymentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalScheduledPaymentsApi();
            var oBWriteInternationalScheduled2Param = new OBWriteInternationalScheduled2(); // OBWriteInternationalScheduled2 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create International Scheduled Payments
                OBWriteInternationalScheduledResponse3 result = apiInstance.createInternationalScheduledPayments(oBWriteInternationalScheduled2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalScheduledPaymentsApi.createInternationalScheduledPayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\InternationalScheduledPaymentsApi();
$oBWriteInternationalScheduled2Param = ; // OBWriteInternationalScheduled2 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createInternationalScheduledPayments($oBWriteInternationalScheduled2Param, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalScheduledPaymentsApi->createInternationalScheduledPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalScheduledPaymentsApi->new();
my $oBWriteInternationalScheduled2Param = WWW::SwaggerClient::Object::OBWriteInternationalScheduled2->new(); # OBWriteInternationalScheduled2 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createInternationalScheduledPayments(oBWriteInternationalScheduled2Param => $oBWriteInternationalScheduled2Param, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalScheduledPaymentsApi->createInternationalScheduledPayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalScheduledPaymentsApi()
oBWriteInternationalScheduled2Param =  # OBWriteInternationalScheduled2 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create International Scheduled Payments
    api_response = api_instance.create_international_scheduled_payments(oBWriteInternationalScheduled2Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalScheduledPaymentsApi->createInternationalScheduledPayments: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBWriteInternationalScheduled2Param *

Responses

Status: 201 - International Scheduled Payments Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getInternationalScheduledPaymentConsentsConsentId

Get International Scheduled Payment Consents


/international-scheduled-payment-consents/{ConsentId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/international-scheduled-payment-consents/{ConsentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.InternationalScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalScheduledConsentResponse3 result = apiInstance.getInternationalScheduledPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#getInternationalScheduledPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.InternationalScheduledPaymentsApi;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalScheduledConsentResponse3 result = apiInstance.getInternationalScheduledPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#getInternationalScheduledPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

InternationalScheduledPaymentsApi *apiInstance = [[InternationalScheduledPaymentsApi alloc] init];

// Get International Scheduled Payment Consents
[apiInstance getInternationalScheduledPaymentConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteInternationalScheduledConsentResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.InternationalScheduledPaymentsApi()

var consentId = consentId_example; // {String} ConsentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalScheduledPaymentConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalScheduledPaymentConsentsConsentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalScheduledPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get International Scheduled Payment Consents
                OBWriteInternationalScheduledConsentResponse3 result = apiInstance.getInternationalScheduledPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalScheduledPaymentsApi.getInternationalScheduledPaymentConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\InternationalScheduledPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getInternationalScheduledPaymentConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalScheduledPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getInternationalScheduledPaymentConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalScheduledPaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get International Scheduled Payment Consents
    api_response = api_instance.get_international_scheduled_payment_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - International Scheduled Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation

Get International Scheduled Payment Consents


/international-scheduled-payment-consents/{ConsentId}/funds-confirmation

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/international-scheduled-payment-consents/{ConsentId}/funds-confirmation"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.InternationalScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteFundsConfirmationResponse1 result = apiInstance.getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.InternationalScheduledPaymentsApi;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteFundsConfirmationResponse1 result = apiInstance.getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

InternationalScheduledPaymentsApi *apiInstance = [[InternationalScheduledPaymentsApi alloc] init];

// Get International Scheduled Payment Consents
[apiInstance getInternationalScheduledPaymentConsentsConsentIdFundsConfirmationWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteFundsConfirmationResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.InternationalScheduledPaymentsApi()

var consentId = consentId_example; // {String} ConsentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalScheduledPaymentConsentsConsentIdFundsConfirmationExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalScheduledPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get International Scheduled Payment Consents
                OBWriteFundsConfirmationResponse1 result = apiInstance.getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalScheduledPaymentsApi.getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\InternationalScheduledPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalScheduledPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalScheduledPaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get International Scheduled Payment Consents
    api_response = api_instance.get_international_scheduled_payment_consents_consent_id_funds_confirmation(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - International Scheduled Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getInternationalScheduledPaymentsInternationalScheduledPaymentId

Get International Scheduled Payments


/international-scheduled-payments/{InternationalScheduledPaymentId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/international-scheduled-payments/{InternationalScheduledPaymentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.InternationalScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        String internationalScheduledPaymentId = internationalScheduledPaymentId_example; // String | InternationalScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalScheduledResponse3 result = apiInstance.getInternationalScheduledPaymentsInternationalScheduledPaymentId(internationalScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#getInternationalScheduledPaymentsInternationalScheduledPaymentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.InternationalScheduledPaymentsApi;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        String internationalScheduledPaymentId = internationalScheduledPaymentId_example; // String | InternationalScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalScheduledResponse3 result = apiInstance.getInternationalScheduledPaymentsInternationalScheduledPaymentId(internationalScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#getInternationalScheduledPaymentsInternationalScheduledPaymentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *internationalScheduledPaymentId = internationalScheduledPaymentId_example; // InternationalScheduledPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

InternationalScheduledPaymentsApi *apiInstance = [[InternationalScheduledPaymentsApi alloc] init];

// Get International Scheduled Payments
[apiInstance getInternationalScheduledPaymentsInternationalScheduledPaymentIdWith:internationalScheduledPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteInternationalScheduledResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.InternationalScheduledPaymentsApi()

var internationalScheduledPaymentId = internationalScheduledPaymentId_example; // {String} InternationalScheduledPaymentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalScheduledPaymentsInternationalScheduledPaymentId(internationalScheduledPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalScheduledPaymentsInternationalScheduledPaymentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalScheduledPaymentsApi();
            var internationalScheduledPaymentId = internationalScheduledPaymentId_example;  // String | InternationalScheduledPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get International Scheduled Payments
                OBWriteInternationalScheduledResponse3 result = apiInstance.getInternationalScheduledPaymentsInternationalScheduledPaymentId(internationalScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalScheduledPaymentsApi.getInternationalScheduledPaymentsInternationalScheduledPaymentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\InternationalScheduledPaymentsApi();
$internationalScheduledPaymentId = internationalScheduledPaymentId_example; // String | InternationalScheduledPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getInternationalScheduledPaymentsInternationalScheduledPaymentId($internationalScheduledPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentsInternationalScheduledPaymentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalScheduledPaymentsApi->new();
my $internationalScheduledPaymentId = internationalScheduledPaymentId_example; # String | InternationalScheduledPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getInternationalScheduledPaymentsInternationalScheduledPaymentId(internationalScheduledPaymentId => $internationalScheduledPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentsInternationalScheduledPaymentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalScheduledPaymentsApi()
internationalScheduledPaymentId = internationalScheduledPaymentId_example # String | InternationalScheduledPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get International Scheduled Payments
    api_response = api_instance.get_international_scheduled_payments_international_scheduled_payment_id(internationalScheduledPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentsInternationalScheduledPaymentId: %s\n" % e)

Parameters

Path parameters
Name Description
InternationalScheduledPaymentId*
String
InternationalScheduledPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - International Scheduled Payments Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

InternationalStandingOrders

createInternationalStandingOrderConsents

Create International Standing Order Consents


/international-standing-order-consents

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/international-standing-order-consents"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.InternationalStandingOrdersApi;

import java.io.File;
import java.util.*;

public class InternationalStandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        InternationalStandingOrdersApi apiInstance = new InternationalStandingOrdersApi();
        OBWriteInternationalStandingOrderConsent4 oBWriteInternationalStandingOrderConsent4Param = ; // OBWriteInternationalStandingOrderConsent4 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalStandingOrderConsentResponse4 result = apiInstance.createInternationalStandingOrderConsents(oBWriteInternationalStandingOrderConsent4Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalStandingOrdersApi#createInternationalStandingOrderConsents");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.InternationalStandingOrdersApi;

public class InternationalStandingOrdersApiExample {

    public static void main(String[] args) {
        InternationalStandingOrdersApi apiInstance = new InternationalStandingOrdersApi();
        OBWriteInternationalStandingOrderConsent4 oBWriteInternationalStandingOrderConsent4Param = ; // OBWriteInternationalStandingOrderConsent4 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalStandingOrderConsentResponse4 result = apiInstance.createInternationalStandingOrderConsents(oBWriteInternationalStandingOrderConsent4Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalStandingOrdersApi#createInternationalStandingOrderConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteInternationalStandingOrderConsent4 *oBWriteInternationalStandingOrderConsent4Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

InternationalStandingOrdersApi *apiInstance = [[InternationalStandingOrdersApi alloc] init];

// Create International Standing Order Consents
[apiInstance createInternationalStandingOrderConsentsWith:oBWriteInternationalStandingOrderConsent4Param
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteInternationalStandingOrderConsentResponse4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.InternationalStandingOrdersApi()

var oBWriteInternationalStandingOrderConsent4Param = ; // {OBWriteInternationalStandingOrderConsent4} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.


var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createInternationalStandingOrderConsents(oBWriteInternationalStandingOrderConsent4Param, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createInternationalStandingOrderConsentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalStandingOrdersApi();
            var oBWriteInternationalStandingOrderConsent4Param = new OBWriteInternationalStandingOrderConsent4(); // OBWriteInternationalStandingOrderConsent4 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create International Standing Order Consents
                OBWriteInternationalStandingOrderConsentResponse4 result = apiInstance.createInternationalStandingOrderConsents(oBWriteInternationalStandingOrderConsent4Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalStandingOrdersApi.createInternationalStandingOrderConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\InternationalStandingOrdersApi();
$oBWriteInternationalStandingOrderConsent4Param = ; // OBWriteInternationalStandingOrderConsent4 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createInternationalStandingOrderConsents($oBWriteInternationalStandingOrderConsent4Param, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalStandingOrdersApi->createInternationalStandingOrderConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalStandingOrdersApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalStandingOrdersApi->new();
my $oBWriteInternationalStandingOrderConsent4Param = WWW::SwaggerClient::Object::OBWriteInternationalStandingOrderConsent4->new(); # OBWriteInternationalStandingOrderConsent4 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createInternationalStandingOrderConsents(oBWriteInternationalStandingOrderConsent4Param => $oBWriteInternationalStandingOrderConsent4Param, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalStandingOrdersApi->createInternationalStandingOrderConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalStandingOrdersApi()
oBWriteInternationalStandingOrderConsent4Param =  # OBWriteInternationalStandingOrderConsent4 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create International Standing Order Consents
    api_response = api_instance.create_international_standing_order_consents(oBWriteInternationalStandingOrderConsent4Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalStandingOrdersApi->createInternationalStandingOrderConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBWriteInternationalStandingOrderConsent4Param *

Responses

Status: 201 - International Standing Order Consents Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

createInternationalStandingOrders

Create International Standing Orders


/international-standing-orders

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/international-standing-orders"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.InternationalStandingOrdersApi;

import java.io.File;
import java.util.*;

public class InternationalStandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        InternationalStandingOrdersApi apiInstance = new InternationalStandingOrdersApi();
        OBWriteInternationalStandingOrder3 oBWriteInternationalStandingOrder3Param = ; // OBWriteInternationalStandingOrder3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalStandingOrderResponse4 result = apiInstance.createInternationalStandingOrders(oBWriteInternationalStandingOrder3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalStandingOrdersApi#createInternationalStandingOrders");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.InternationalStandingOrdersApi;

public class InternationalStandingOrdersApiExample {

    public static void main(String[] args) {
        InternationalStandingOrdersApi apiInstance = new InternationalStandingOrdersApi();
        OBWriteInternationalStandingOrder3 oBWriteInternationalStandingOrder3Param = ; // OBWriteInternationalStandingOrder3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalStandingOrderResponse4 result = apiInstance.createInternationalStandingOrders(oBWriteInternationalStandingOrder3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalStandingOrdersApi#createInternationalStandingOrders");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

OBWriteInternationalStandingOrder3 *oBWriteInternationalStandingOrder3Param = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

InternationalStandingOrdersApi *apiInstance = [[InternationalStandingOrdersApi alloc] init];

// Create International Standing Orders
[apiInstance createInternationalStandingOrdersWith:oBWriteInternationalStandingOrder3Param
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteInternationalStandingOrderResponse4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.InternationalStandingOrdersApi()

var oBWriteInternationalStandingOrder3Param = ; // {OBWriteInternationalStandingOrder3} Default

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var xIdempotencyKey = xIdempotencyKey_example; // {String} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.


var xJwsSignature = xJwsSignature_example; // {String} A detached JWS signature of the body of the payload.

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createInternationalStandingOrders(oBWriteInternationalStandingOrder3Param, authorizationxIdempotencyKey, xJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createInternationalStandingOrdersExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalStandingOrdersApi();
            var oBWriteInternationalStandingOrder3Param = new OBWriteInternationalStandingOrder3(); // OBWriteInternationalStandingOrder3 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Create International Standing Orders
                OBWriteInternationalStandingOrderResponse4 result = apiInstance.createInternationalStandingOrders(oBWriteInternationalStandingOrder3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalStandingOrdersApi.createInternationalStandingOrders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\InternationalStandingOrdersApi();
$oBWriteInternationalStandingOrder3Param = ; // OBWriteInternationalStandingOrder3 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->createInternationalStandingOrders($oBWriteInternationalStandingOrder3Param, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalStandingOrdersApi->createInternationalStandingOrders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalStandingOrdersApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalStandingOrdersApi->new();
my $oBWriteInternationalStandingOrder3Param = WWW::SwaggerClient::Object::OBWriteInternationalStandingOrder3->new(); # OBWriteInternationalStandingOrder3 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->createInternationalStandingOrders(oBWriteInternationalStandingOrder3Param => $oBWriteInternationalStandingOrder3Param, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalStandingOrdersApi->createInternationalStandingOrders: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalStandingOrdersApi()
oBWriteInternationalStandingOrder3Param =  # OBWriteInternationalStandingOrder3 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Create International Standing Orders
    api_response = api_instance.create_international_standing_orders(oBWriteInternationalStandingOrder3Param, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalStandingOrdersApi->createInternationalStandingOrders: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
Body parameters
Name Description
oBWriteInternationalStandingOrder3Param *

Responses

Status: 201 - International Standing Orders Created

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getInternationalStandingOrderConsentsConsentId

Get International Standing Order Consents


/international-standing-order-consents/{ConsentId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/international-standing-order-consents/{ConsentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.InternationalStandingOrdersApi;

import java.io.File;
import java.util.*;

public class InternationalStandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        InternationalStandingOrdersApi apiInstance = new InternationalStandingOrdersApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalStandingOrderConsentResponse4 result = apiInstance.getInternationalStandingOrderConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalStandingOrdersApi#getInternationalStandingOrderConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.InternationalStandingOrdersApi;

public class InternationalStandingOrdersApiExample {

    public static void main(String[] args) {
        InternationalStandingOrdersApi apiInstance = new InternationalStandingOrdersApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalStandingOrderConsentResponse4 result = apiInstance.getInternationalStandingOrderConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalStandingOrdersApi#getInternationalStandingOrderConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

InternationalStandingOrdersApi *apiInstance = [[InternationalStandingOrdersApi alloc] init];

// Get International Standing Order Consents
[apiInstance getInternationalStandingOrderConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteInternationalStandingOrderConsentResponse4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.InternationalStandingOrdersApi()

var consentId = consentId_example; // {String} ConsentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalStandingOrderConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalStandingOrderConsentsConsentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalStandingOrdersApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get International Standing Order Consents
                OBWriteInternationalStandingOrderConsentResponse4 result = apiInstance.getInternationalStandingOrderConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalStandingOrdersApi.getInternationalStandingOrderConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\InternationalStandingOrdersApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getInternationalStandingOrderConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalStandingOrdersApi->getInternationalStandingOrderConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalStandingOrdersApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalStandingOrdersApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getInternationalStandingOrderConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalStandingOrdersApi->getInternationalStandingOrderConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalStandingOrdersApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get International Standing Order Consents
    api_response = api_instance.get_international_standing_order_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalStandingOrdersApi->getInternationalStandingOrderConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - International Standing Order Consents Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getInternationalStandingOrdersInternationalStandingOrderPaymentId

Get International Standing Orders


/international-standing-orders/{InternationalStandingOrderPaymentId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/international-standing-orders/{InternationalStandingOrderPaymentId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.InternationalStandingOrdersApi;

import java.io.File;
import java.util.*;

public class InternationalStandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        InternationalStandingOrdersApi apiInstance = new InternationalStandingOrdersApi();
        String internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // String | InternationalStandingOrderPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalStandingOrderResponse4 result = apiInstance.getInternationalStandingOrdersInternationalStandingOrderPaymentId(internationalStandingOrderPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalStandingOrdersApi#getInternationalStandingOrdersInternationalStandingOrderPaymentId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.InternationalStandingOrdersApi;

public class InternationalStandingOrdersApiExample {

    public static void main(String[] args) {
        InternationalStandingOrdersApi apiInstance = new InternationalStandingOrdersApi();
        String internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // String | InternationalStandingOrderPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWriteInternationalStandingOrderResponse4 result = apiInstance.getInternationalStandingOrdersInternationalStandingOrderPaymentId(internationalStandingOrderPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalStandingOrdersApi#getInternationalStandingOrdersInternationalStandingOrderPaymentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // InternationalStandingOrderPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

InternationalStandingOrdersApi *apiInstance = [[InternationalStandingOrdersApi alloc] init];

// Get International Standing Orders
[apiInstance getInternationalStandingOrdersInternationalStandingOrderPaymentIdWith:internationalStandingOrderPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWriteInternationalStandingOrderResponse4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.InternationalStandingOrdersApi()

var internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // {String} InternationalStandingOrderPaymentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalStandingOrdersInternationalStandingOrderPaymentId(internationalStandingOrderPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalStandingOrdersInternationalStandingOrderPaymentIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalStandingOrdersApi();
            var internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example;  // String | InternationalStandingOrderPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get International Standing Orders
                OBWriteInternationalStandingOrderResponse4 result = apiInstance.getInternationalStandingOrdersInternationalStandingOrderPaymentId(internationalStandingOrderPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalStandingOrdersApi.getInternationalStandingOrdersInternationalStandingOrderPaymentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\InternationalStandingOrdersApi();
$internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // String | InternationalStandingOrderPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getInternationalStandingOrdersInternationalStandingOrderPaymentId($internationalStandingOrderPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalStandingOrdersApi->getInternationalStandingOrdersInternationalStandingOrderPaymentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalStandingOrdersApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalStandingOrdersApi->new();
my $internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; # String | InternationalStandingOrderPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getInternationalStandingOrdersInternationalStandingOrderPaymentId(internationalStandingOrderPaymentId => $internationalStandingOrderPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalStandingOrdersApi->getInternationalStandingOrdersInternationalStandingOrderPaymentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalStandingOrdersApi()
internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example # String | InternationalStandingOrderPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get International Standing Orders
    api_response = api_instance.get_international_standing_orders_international_standing_order_payment_id(internationalStandingOrderPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalStandingOrdersApi->getInternationalStandingOrdersInternationalStandingOrderPaymentId: %s\n" % e)

Parameters

Path parameters
Name Description
InternationalStandingOrderPaymentId*
String
InternationalStandingOrderPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - International Standing Orders Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

OBAccountPaymentServiceProviders

oBAccountPaymentServiceProvidersGet

Search for one or more resources


/OBAccountPaymentServiceProviders

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/OBAccountPaymentServiceProviders?attributes=&excludedAttributes=&filter=&sortBy=&sortOrder=&startIndex=&count="
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OBAccountPaymentServiceProvidersApi;

import java.io.File;
import java.util.*;

public class OBAccountPaymentServiceProvidersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        OBAccountPaymentServiceProvidersApi apiInstance = new OBAccountPaymentServiceProvidersApi();
        String attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
        String excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
        String filter = filter_example; // String | The filter string used to request a subset of resources.
        String sortBy = sortBy_example; // String | A string indicating the attribute whose value shall be used to order the returned responses.
        String sortOrder = sortOrder_example; // String | A string indicating the order in which the 'sortBy' parameter is applied.
        Integer startIndex = 56; // Integer | An integer indicating the 1-based index of the first query result.
        Integer count = 56; // Integer | An integer indicating the desired maximum number of query results per page.
        try {
            OBAccountPaymentServiceProvidersResponse result = apiInstance.oBAccountPaymentServiceProvidersGet(attributes, excludedAttributes, filter, sortBy, sortOrder, startIndex, count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBAccountPaymentServiceProvidersApi#oBAccountPaymentServiceProvidersGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OBAccountPaymentServiceProvidersApi;

public class OBAccountPaymentServiceProvidersApiExample {

    public static void main(String[] args) {
        OBAccountPaymentServiceProvidersApi apiInstance = new OBAccountPaymentServiceProvidersApi();
        String attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
        String excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
        String filter = filter_example; // String | The filter string used to request a subset of resources.
        String sortBy = sortBy_example; // String | A string indicating the attribute whose value shall be used to order the returned responses.
        String sortOrder = sortOrder_example; // String | A string indicating the order in which the 'sortBy' parameter is applied.
        Integer startIndex = 56; // Integer | An integer indicating the 1-based index of the first query result.
        Integer count = 56; // Integer | An integer indicating the desired maximum number of query results per page.
        try {
            OBAccountPaymentServiceProvidersResponse result = apiInstance.oBAccountPaymentServiceProvidersGet(attributes, excludedAttributes, filter, sortBy, sortOrder, startIndex, count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBAccountPaymentServiceProvidersApi#oBAccountPaymentServiceProvidersGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *attributes = attributes_example; // A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional)
String *excludedAttributes = excludedAttributes_example; // A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional)
String *filter = filter_example; // The filter string used to request a subset of resources. (optional)
String *sortBy = sortBy_example; // A string indicating the attribute whose value shall be used to order the returned responses. (optional)
String *sortOrder = sortOrder_example; // A string indicating the order in which the 'sortBy' parameter is applied. (optional)
Integer *startIndex = 56; // An integer indicating the 1-based index of the first query result. (optional)
Integer *count = 56; // An integer indicating the desired maximum number of query results per page. (optional)

OBAccountPaymentServiceProvidersApi *apiInstance = [[OBAccountPaymentServiceProvidersApi alloc] init];

// Search for one or more resources
[apiInstance oBAccountPaymentServiceProvidersGetWith:attributes
    excludedAttributes:excludedAttributes
    filter:filter
    sortBy:sortBy
    sortOrder:sortOrder
    startIndex:startIndex
    count:count
              completionHandler: ^(OBAccountPaymentServiceProvidersResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OBAccountPaymentServiceProvidersApi()

var opts = { 
  'attributes': attributes_example, // {String} A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
  'excludedAttributes': excludedAttributes_example // {String} A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
  'filter': filter_example, // {String} The filter string used to request a subset of resources.
  'sortBy': sortBy_example, // {String} A string indicating the attribute whose value shall be used to order the returned responses.
  'sortOrder': sortOrder_example, // {String} A string indicating the order in which the 'sortBy' parameter is applied.
  'startIndex': 56, // {Integer} An integer indicating the 1-based index of the first query result.
  'count': 56 // {Integer} An integer indicating the desired maximum number of query results per page.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.oBAccountPaymentServiceProvidersGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class oBAccountPaymentServiceProvidersGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OBAccountPaymentServiceProvidersApi();
            var attributes = attributes_example;  // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional) 
            var excludedAttributes = excludedAttributes_example;  // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional) 
            var filter = filter_example;  // String | The filter string used to request a subset of resources. (optional) 
            var sortBy = sortBy_example;  // String | A string indicating the attribute whose value shall be used to order the returned responses. (optional) 
            var sortOrder = sortOrder_example;  // String | A string indicating the order in which the 'sortBy' parameter is applied. (optional) 
            var startIndex = 56;  // Integer | An integer indicating the 1-based index of the first query result. (optional) 
            var count = 56;  // Integer | An integer indicating the desired maximum number of query results per page. (optional) 

            try
            {
                // Search for one or more resources
                OBAccountPaymentServiceProvidersResponse result = apiInstance.oBAccountPaymentServiceProvidersGet(attributes, excludedAttributes, filter, sortBy, sortOrder, startIndex, count);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OBAccountPaymentServiceProvidersApi.oBAccountPaymentServiceProvidersGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OBAccountPaymentServiceProvidersApi();
$attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
$excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
$filter = filter_example; // String | The filter string used to request a subset of resources.
$sortBy = sortBy_example; // String | A string indicating the attribute whose value shall be used to order the returned responses.
$sortOrder = sortOrder_example; // String | A string indicating the order in which the 'sortBy' parameter is applied.
$startIndex = 56; // Integer | An integer indicating the 1-based index of the first query result.
$count = 56; // Integer | An integer indicating the desired maximum number of query results per page.

try {
    $result = $api_instance->oBAccountPaymentServiceProvidersGet($attributes, $excludedAttributes, $filter, $sortBy, $sortOrder, $startIndex, $count);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OBAccountPaymentServiceProvidersApi->oBAccountPaymentServiceProvidersGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OBAccountPaymentServiceProvidersApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OBAccountPaymentServiceProvidersApi->new();
my $attributes = attributes_example; # String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
my $excludedAttributes = excludedAttributes_example; # String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
my $filter = filter_example; # String | The filter string used to request a subset of resources.
my $sortBy = sortBy_example; # String | A string indicating the attribute whose value shall be used to order the returned responses.
my $sortOrder = sortOrder_example; # String | A string indicating the order in which the 'sortBy' parameter is applied.
my $startIndex = 56; # Integer | An integer indicating the 1-based index of the first query result.
my $count = 56; # Integer | An integer indicating the desired maximum number of query results per page.

eval { 
    my $result = $api_instance->oBAccountPaymentServiceProvidersGet(attributes => $attributes, excludedAttributes => $excludedAttributes, filter => $filter, sortBy => $sortBy, sortOrder => $sortOrder, startIndex => $startIndex, count => $count);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OBAccountPaymentServiceProvidersApi->oBAccountPaymentServiceProvidersGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OBAccountPaymentServiceProvidersApi()
attributes = attributes_example # String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional)
excludedAttributes = excludedAttributes_example # String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional)
filter = filter_example # String | The filter string used to request a subset of resources. (optional)
sortBy = sortBy_example # String | A string indicating the attribute whose value shall be used to order the returned responses. (optional)
sortOrder = sortOrder_example # String | A string indicating the order in which the 'sortBy' parameter is applied. (optional)
startIndex = 56 # Integer | An integer indicating the 1-based index of the first query result. (optional)
count = 56 # Integer | An integer indicating the desired maximum number of query results per page. (optional)

try: 
    # Search for one or more resources
    api_response = api_instance.o_b_account_payment_service_providers_get(attributes=attributes, excludedAttributes=excludedAttributes, filter=filter, sortBy=sortBy, sortOrder=sortOrder, startIndex=startIndex, count=count)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OBAccountPaymentServiceProvidersApi->oBAccountPaymentServiceProvidersGet: %s\n" % e)

Parameters

Query parameters
Name Description
attributes
String
A comma separated list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default. 'excludedAttributes' must not also be specified if this is specified.
excludedAttributes
String
A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
filter
String
The filter string used to request a subset of resources.
sortBy
String
A string indicating the attribute whose value shall be used to order the returned responses.
sortOrder
String
A string indicating the order in which the 'sortBy' parameter is applied.
startIndex
Integer
An integer indicating the 1-based index of the first query result.
count
Integer
An integer indicating the desired maximum number of query results per page.

Responses

Status: 200 - SCIM 2.0 List Response Message

Status: default - An error occurred while executing the operation


oBAccountPaymentServiceProvidersIdGet

Retrieve the resource


/OBAccountPaymentServiceProviders/{id}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/OBAccountPaymentServiceProviders/{id}?attributes=&excludedAttributes="
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OBAccountPaymentServiceProvidersApi;

import java.io.File;
import java.util.*;

public class OBAccountPaymentServiceProvidersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        OBAccountPaymentServiceProvidersApi apiInstance = new OBAccountPaymentServiceProvidersApi();
        String id = id_example; // String | The resource identifier (value of the 'id' attribute).
        String attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
        String excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
        try {
            OBAccountPaymentServiceProviders result = apiInstance.oBAccountPaymentServiceProvidersIdGet(id, attributes, excludedAttributes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBAccountPaymentServiceProvidersApi#oBAccountPaymentServiceProvidersIdGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OBAccountPaymentServiceProvidersApi;

public class OBAccountPaymentServiceProvidersApiExample {

    public static void main(String[] args) {
        OBAccountPaymentServiceProvidersApi apiInstance = new OBAccountPaymentServiceProvidersApi();
        String id = id_example; // String | The resource identifier (value of the 'id' attribute).
        String attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
        String excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
        try {
            OBAccountPaymentServiceProviders result = apiInstance.oBAccountPaymentServiceProvidersIdGet(id, attributes, excludedAttributes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBAccountPaymentServiceProvidersApi#oBAccountPaymentServiceProvidersIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *id = id_example; // The resource identifier (value of the 'id' attribute).
String *attributes = attributes_example; // A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional)
String *excludedAttributes = excludedAttributes_example; // A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional)

OBAccountPaymentServiceProvidersApi *apiInstance = [[OBAccountPaymentServiceProvidersApi alloc] init];

// Retrieve the resource
[apiInstance oBAccountPaymentServiceProvidersIdGetWith:id
    attributes:attributes
    excludedAttributes:excludedAttributes
              completionHandler: ^(OBAccountPaymentServiceProviders output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OBAccountPaymentServiceProvidersApi()

var id = id_example; // {String} The resource identifier (value of the 'id' attribute).

var opts = { 
  'attributes': attributes_example, // {String} A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
  'excludedAttributes': excludedAttributes_example // {String} A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.oBAccountPaymentServiceProvidersIdGet(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class oBAccountPaymentServiceProvidersIdGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OBAccountPaymentServiceProvidersApi();
            var id = id_example;  // String | The resource identifier (value of the 'id' attribute).
            var attributes = attributes_example;  // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional) 
            var excludedAttributes = excludedAttributes_example;  // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional) 

            try
            {
                // Retrieve the resource
                OBAccountPaymentServiceProviders result = apiInstance.oBAccountPaymentServiceProvidersIdGet(id, attributes, excludedAttributes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OBAccountPaymentServiceProvidersApi.oBAccountPaymentServiceProvidersIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OBAccountPaymentServiceProvidersApi();
$id = id_example; // String | The resource identifier (value of the 'id' attribute).
$attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
$excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.

try {
    $result = $api_instance->oBAccountPaymentServiceProvidersIdGet($id, $attributes, $excludedAttributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OBAccountPaymentServiceProvidersApi->oBAccountPaymentServiceProvidersIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OBAccountPaymentServiceProvidersApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OBAccountPaymentServiceProvidersApi->new();
my $id = id_example; # String | The resource identifier (value of the 'id' attribute).
my $attributes = attributes_example; # String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
my $excludedAttributes = excludedAttributes_example; # String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.

eval { 
    my $result = $api_instance->oBAccountPaymentServiceProvidersIdGet(id => $id, attributes => $attributes, excludedAttributes => $excludedAttributes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OBAccountPaymentServiceProvidersApi->oBAccountPaymentServiceProvidersIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OBAccountPaymentServiceProvidersApi()
id = id_example # String | The resource identifier (value of the 'id' attribute).
attributes = attributes_example # String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional)
excludedAttributes = excludedAttributes_example # String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional)

try: 
    # Retrieve the resource
    api_response = api_instance.o_b_account_payment_service_providers_id_get(id, attributes=attributes, excludedAttributes=excludedAttributes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OBAccountPaymentServiceProvidersApi->oBAccountPaymentServiceProvidersIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
The resource identifier (value of the 'id' attribute).
Required
Query parameters
Name Description
attributes
String
A comma separated list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default. 'excludedAttributes' must not also be specified if this is specified.
excludedAttributes
String
A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.

Responses

Status: 200 - The retrieved resource is included in the response body

Status: default - An error occurred while executing the operation


oBAccountPaymentServiceProvidersSearchPost

Search for one or more resources using HTTP POST

Useful for executing searches without passing parameters that may contain sensitive information on the URL.


/OBAccountPaymentServiceProviders/.search

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/OBAccountPaymentServiceProviders/.search"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OBAccountPaymentServiceProvidersApi;

import java.io.File;
import java.util.*;

public class OBAccountPaymentServiceProvidersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        OBAccountPaymentServiceProvidersApi apiInstance = new OBAccountPaymentServiceProvidersApi();
        SearchRequest sCIM 2.0 Search Request Message = ; // SearchRequest | 
        try {
            inline_response_200 result = apiInstance.oBAccountPaymentServiceProvidersSearchPost(sCIM 2.0 Search Request Message);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBAccountPaymentServiceProvidersApi#oBAccountPaymentServiceProvidersSearchPost");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OBAccountPaymentServiceProvidersApi;

public class OBAccountPaymentServiceProvidersApiExample {

    public static void main(String[] args) {
        OBAccountPaymentServiceProvidersApi apiInstance = new OBAccountPaymentServiceProvidersApi();
        SearchRequest sCIM 2.0 Search Request Message = ; // SearchRequest | 
        try {
            inline_response_200 result = apiInstance.oBAccountPaymentServiceProvidersSearchPost(sCIM 2.0 Search Request Message);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBAccountPaymentServiceProvidersApi#oBAccountPaymentServiceProvidersSearchPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

SearchRequest *sCIM 2.0 Search Request Message = ; //  (optional)

OBAccountPaymentServiceProvidersApi *apiInstance = [[OBAccountPaymentServiceProvidersApi alloc] init];

// Search for one or more resources using HTTP POST
[apiInstance oBAccountPaymentServiceProvidersSearchPostWith:sCIM 2.0 Search Request Message
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OBAccountPaymentServiceProvidersApi()

var opts = { 
  'sCIM 2.0 Search Request Message':  // {SearchRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.oBAccountPaymentServiceProvidersSearchPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class oBAccountPaymentServiceProvidersSearchPostExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OBAccountPaymentServiceProvidersApi();
            var sCIM 2.0 Search Request Message = new SearchRequest(); // SearchRequest |  (optional) 

            try
            {
                // Search for one or more resources using HTTP POST
                inline_response_200 result = apiInstance.oBAccountPaymentServiceProvidersSearchPost(sCIM 2.0 Search Request Message);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OBAccountPaymentServiceProvidersApi.oBAccountPaymentServiceProvidersSearchPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OBAccountPaymentServiceProvidersApi();
$sCIM 2.0 Search Request Message = ; // SearchRequest | 

try {
    $result = $api_instance->oBAccountPaymentServiceProvidersSearchPost($sCIM 2.0 Search Request Message);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OBAccountPaymentServiceProvidersApi->oBAccountPaymentServiceProvidersSearchPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OBAccountPaymentServiceProvidersApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OBAccountPaymentServiceProvidersApi->new();
my $sCIM 2.0 Search Request Message = WWW::SwaggerClient::Object::SearchRequest->new(); # SearchRequest | 

eval { 
    my $result = $api_instance->oBAccountPaymentServiceProvidersSearchPost(sCIM 2.0 Search Request Message => $sCIM 2.0 Search Request Message);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OBAccountPaymentServiceProvidersApi->oBAccountPaymentServiceProvidersSearchPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OBAccountPaymentServiceProvidersApi()
sCIM 2.0 Search Request Message =  # SearchRequest |  (optional)

try: 
    # Search for one or more resources using HTTP POST
    api_response = api_instance.o_b_account_payment_service_providers_search_post(sCIM 2.0 Search Request Message=sCIM 2.0 Search Request Message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OBAccountPaymentServiceProvidersApi->oBAccountPaymentServiceProvidersSearchPost: %s\n" % e)

Parameters

Body parameters
Name Description
sCIM 2.0 Search Request Message

Responses

Status: 200 - SCIM 2.0 List Response Message

Status: default - An error occurred while executing the operation


OBAuthorities

oBAuthoritiesGet

Search for one or more resources


/OBAuthorities

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/OBAuthorities?attributes=&excludedAttributes=&filter=&sortBy=&sortOrder=&startIndex=&count="
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OBAuthoritiesApi;

import java.io.File;
import java.util.*;

public class OBAuthoritiesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        OBAuthoritiesApi apiInstance = new OBAuthoritiesApi();
        String attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
        String excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
        String filter = filter_example; // String | The filter string used to request a subset of resources.
        String sortBy = sortBy_example; // String | A string indicating the attribute whose value shall be used to order the returned responses.
        String sortOrder = sortOrder_example; // String | A string indicating the order in which the 'sortBy' parameter is applied.
        Integer startIndex = 56; // Integer | An integer indicating the 1-based index of the first query result.
        Integer count = 56; // Integer | An integer indicating the desired maximum number of query results per page.
        try {
            inline_response_200_1 result = apiInstance.oBAuthoritiesGet(attributes, excludedAttributes, filter, sortBy, sortOrder, startIndex, count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBAuthoritiesApi#oBAuthoritiesGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OBAuthoritiesApi;

public class OBAuthoritiesApiExample {

    public static void main(String[] args) {
        OBAuthoritiesApi apiInstance = new OBAuthoritiesApi();
        String attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
        String excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
        String filter = filter_example; // String | The filter string used to request a subset of resources.
        String sortBy = sortBy_example; // String | A string indicating the attribute whose value shall be used to order the returned responses.
        String sortOrder = sortOrder_example; // String | A string indicating the order in which the 'sortBy' parameter is applied.
        Integer startIndex = 56; // Integer | An integer indicating the 1-based index of the first query result.
        Integer count = 56; // Integer | An integer indicating the desired maximum number of query results per page.
        try {
            inline_response_200_1 result = apiInstance.oBAuthoritiesGet(attributes, excludedAttributes, filter, sortBy, sortOrder, startIndex, count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBAuthoritiesApi#oBAuthoritiesGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *attributes = attributes_example; // A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional)
String *excludedAttributes = excludedAttributes_example; // A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional)
String *filter = filter_example; // The filter string used to request a subset of resources. (optional)
String *sortBy = sortBy_example; // A string indicating the attribute whose value shall be used to order the returned responses. (optional)
String *sortOrder = sortOrder_example; // A string indicating the order in which the 'sortBy' parameter is applied. (optional)
Integer *startIndex = 56; // An integer indicating the 1-based index of the first query result. (optional)
Integer *count = 56; // An integer indicating the desired maximum number of query results per page. (optional)

OBAuthoritiesApi *apiInstance = [[OBAuthoritiesApi alloc] init];

// Search for one or more resources
[apiInstance oBAuthoritiesGetWith:attributes
    excludedAttributes:excludedAttributes
    filter:filter
    sortBy:sortBy
    sortOrder:sortOrder
    startIndex:startIndex
    count:count
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OBAuthoritiesApi()

var opts = { 
  'attributes': attributes_example, // {String} A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
  'excludedAttributes': excludedAttributes_example // {String} A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
  'filter': filter_example, // {String} The filter string used to request a subset of resources.
  'sortBy': sortBy_example, // {String} A string indicating the attribute whose value shall be used to order the returned responses.
  'sortOrder': sortOrder_example, // {String} A string indicating the order in which the 'sortBy' parameter is applied.
  'startIndex': 56, // {Integer} An integer indicating the 1-based index of the first query result.
  'count': 56 // {Integer} An integer indicating the desired maximum number of query results per page.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.oBAuthoritiesGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class oBAuthoritiesGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OBAuthoritiesApi();
            var attributes = attributes_example;  // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional) 
            var excludedAttributes = excludedAttributes_example;  // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional) 
            var filter = filter_example;  // String | The filter string used to request a subset of resources. (optional) 
            var sortBy = sortBy_example;  // String | A string indicating the attribute whose value shall be used to order the returned responses. (optional) 
            var sortOrder = sortOrder_example;  // String | A string indicating the order in which the 'sortBy' parameter is applied. (optional) 
            var startIndex = 56;  // Integer | An integer indicating the 1-based index of the first query result. (optional) 
            var count = 56;  // Integer | An integer indicating the desired maximum number of query results per page. (optional) 

            try
            {
                // Search for one or more resources
                inline_response_200_1 result = apiInstance.oBAuthoritiesGet(attributes, excludedAttributes, filter, sortBy, sortOrder, startIndex, count);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OBAuthoritiesApi.oBAuthoritiesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OBAuthoritiesApi();
$attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
$excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
$filter = filter_example; // String | The filter string used to request a subset of resources.
$sortBy = sortBy_example; // String | A string indicating the attribute whose value shall be used to order the returned responses.
$sortOrder = sortOrder_example; // String | A string indicating the order in which the 'sortBy' parameter is applied.
$startIndex = 56; // Integer | An integer indicating the 1-based index of the first query result.
$count = 56; // Integer | An integer indicating the desired maximum number of query results per page.

try {
    $result = $api_instance->oBAuthoritiesGet($attributes, $excludedAttributes, $filter, $sortBy, $sortOrder, $startIndex, $count);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OBAuthoritiesApi->oBAuthoritiesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OBAuthoritiesApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OBAuthoritiesApi->new();
my $attributes = attributes_example; # String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
my $excludedAttributes = excludedAttributes_example; # String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
my $filter = filter_example; # String | The filter string used to request a subset of resources.
my $sortBy = sortBy_example; # String | A string indicating the attribute whose value shall be used to order the returned responses.
my $sortOrder = sortOrder_example; # String | A string indicating the order in which the 'sortBy' parameter is applied.
my $startIndex = 56; # Integer | An integer indicating the 1-based index of the first query result.
my $count = 56; # Integer | An integer indicating the desired maximum number of query results per page.

eval { 
    my $result = $api_instance->oBAuthoritiesGet(attributes => $attributes, excludedAttributes => $excludedAttributes, filter => $filter, sortBy => $sortBy, sortOrder => $sortOrder, startIndex => $startIndex, count => $count);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OBAuthoritiesApi->oBAuthoritiesGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OBAuthoritiesApi()
attributes = attributes_example # String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional)
excludedAttributes = excludedAttributes_example # String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional)
filter = filter_example # String | The filter string used to request a subset of resources. (optional)
sortBy = sortBy_example # String | A string indicating the attribute whose value shall be used to order the returned responses. (optional)
sortOrder = sortOrder_example # String | A string indicating the order in which the 'sortBy' parameter is applied. (optional)
startIndex = 56 # Integer | An integer indicating the 1-based index of the first query result. (optional)
count = 56 # Integer | An integer indicating the desired maximum number of query results per page. (optional)

try: 
    # Search for one or more resources
    api_response = api_instance.o_b_authorities_get(attributes=attributes, excludedAttributes=excludedAttributes, filter=filter, sortBy=sortBy, sortOrder=sortOrder, startIndex=startIndex, count=count)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OBAuthoritiesApi->oBAuthoritiesGet: %s\n" % e)

Parameters

Query parameters
Name Description
attributes
String
A comma separated list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default. 'excludedAttributes' must not also be specified if this is specified.
excludedAttributes
String
A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
filter
String
The filter string used to request a subset of resources.
sortBy
String
A string indicating the attribute whose value shall be used to order the returned responses.
sortOrder
String
A string indicating the order in which the 'sortBy' parameter is applied.
startIndex
Integer
An integer indicating the 1-based index of the first query result.
count
Integer
An integer indicating the desired maximum number of query results per page.

Responses

Status: 200 - SCIM 2.0 List Response Message

Status: default - An error occurred while executing the operation


oBAuthoritiesIdGet

Retrieve the resource


/OBAuthorities/{id}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/OBAuthorities/{id}?attributes=&excludedAttributes="
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OBAuthoritiesApi;

import java.io.File;
import java.util.*;

public class OBAuthoritiesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        OBAuthoritiesApi apiInstance = new OBAuthoritiesApi();
        String id = id_example; // String | The resource identifier (value of the 'id' attribute).
        String attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
        String excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
        try {
            OBAuthorities result = apiInstance.oBAuthoritiesIdGet(id, attributes, excludedAttributes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBAuthoritiesApi#oBAuthoritiesIdGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OBAuthoritiesApi;

public class OBAuthoritiesApiExample {

    public static void main(String[] args) {
        OBAuthoritiesApi apiInstance = new OBAuthoritiesApi();
        String id = id_example; // String | The resource identifier (value of the 'id' attribute).
        String attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
        String excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
        try {
            OBAuthorities result = apiInstance.oBAuthoritiesIdGet(id, attributes, excludedAttributes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBAuthoritiesApi#oBAuthoritiesIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *id = id_example; // The resource identifier (value of the 'id' attribute).
String *attributes = attributes_example; // A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional)
String *excludedAttributes = excludedAttributes_example; // A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional)

OBAuthoritiesApi *apiInstance = [[OBAuthoritiesApi alloc] init];

// Retrieve the resource
[apiInstance oBAuthoritiesIdGetWith:id
    attributes:attributes
    excludedAttributes:excludedAttributes
              completionHandler: ^(OBAuthorities output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OBAuthoritiesApi()

var id = id_example; // {String} The resource identifier (value of the 'id' attribute).

var opts = { 
  'attributes': attributes_example, // {String} A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
  'excludedAttributes': excludedAttributes_example // {String} A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.oBAuthoritiesIdGet(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class oBAuthoritiesIdGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OBAuthoritiesApi();
            var id = id_example;  // String | The resource identifier (value of the 'id' attribute).
            var attributes = attributes_example;  // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional) 
            var excludedAttributes = excludedAttributes_example;  // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional) 

            try
            {
                // Retrieve the resource
                OBAuthorities result = apiInstance.oBAuthoritiesIdGet(id, attributes, excludedAttributes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OBAuthoritiesApi.oBAuthoritiesIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OBAuthoritiesApi();
$id = id_example; // String | The resource identifier (value of the 'id' attribute).
$attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
$excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.

try {
    $result = $api_instance->oBAuthoritiesIdGet($id, $attributes, $excludedAttributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OBAuthoritiesApi->oBAuthoritiesIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OBAuthoritiesApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OBAuthoritiesApi->new();
my $id = id_example; # String | The resource identifier (value of the 'id' attribute).
my $attributes = attributes_example; # String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
my $excludedAttributes = excludedAttributes_example; # String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.

eval { 
    my $result = $api_instance->oBAuthoritiesIdGet(id => $id, attributes => $attributes, excludedAttributes => $excludedAttributes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OBAuthoritiesApi->oBAuthoritiesIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OBAuthoritiesApi()
id = id_example # String | The resource identifier (value of the 'id' attribute).
attributes = attributes_example # String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional)
excludedAttributes = excludedAttributes_example # String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional)

try: 
    # Retrieve the resource
    api_response = api_instance.o_b_authorities_id_get(id, attributes=attributes, excludedAttributes=excludedAttributes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OBAuthoritiesApi->oBAuthoritiesIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
The resource identifier (value of the 'id' attribute).
Required
Query parameters
Name Description
attributes
String
A comma separated list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default. 'excludedAttributes' must not also be specified if this is specified.
excludedAttributes
String
A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.

Responses

Status: 200 - The retrieved resource is included in the response body

Status: default - An error occurred while executing the operation


oBAuthoritiesSearchPost

Search for one or more resources using HTTP POST

Useful for executing searches without passing parameters that may contain sensitive information on the URL.


/OBAuthorities/.search

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/OBAuthorities/.search"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OBAuthoritiesApi;

import java.io.File;
import java.util.*;

public class OBAuthoritiesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        OBAuthoritiesApi apiInstance = new OBAuthoritiesApi();
        SearchRequest sCIM 2.0 Search Request Message = ; // SearchRequest | 
        try {
            inline_response_200_1 result = apiInstance.oBAuthoritiesSearchPost(sCIM 2.0 Search Request Message);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBAuthoritiesApi#oBAuthoritiesSearchPost");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OBAuthoritiesApi;

public class OBAuthoritiesApiExample {

    public static void main(String[] args) {
        OBAuthoritiesApi apiInstance = new OBAuthoritiesApi();
        SearchRequest sCIM 2.0 Search Request Message = ; // SearchRequest | 
        try {
            inline_response_200_1 result = apiInstance.oBAuthoritiesSearchPost(sCIM 2.0 Search Request Message);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBAuthoritiesApi#oBAuthoritiesSearchPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

SearchRequest *sCIM 2.0 Search Request Message = ; //  (optional)

OBAuthoritiesApi *apiInstance = [[OBAuthoritiesApi alloc] init];

// Search for one or more resources using HTTP POST
[apiInstance oBAuthoritiesSearchPostWith:sCIM 2.0 Search Request Message
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OBAuthoritiesApi()

var opts = { 
  'sCIM 2.0 Search Request Message':  // {SearchRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.oBAuthoritiesSearchPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class oBAuthoritiesSearchPostExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OBAuthoritiesApi();
            var sCIM 2.0 Search Request Message = new SearchRequest(); // SearchRequest |  (optional) 

            try
            {
                // Search for one or more resources using HTTP POST
                inline_response_200_1 result = apiInstance.oBAuthoritiesSearchPost(sCIM 2.0 Search Request Message);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OBAuthoritiesApi.oBAuthoritiesSearchPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OBAuthoritiesApi();
$sCIM 2.0 Search Request Message = ; // SearchRequest | 

try {
    $result = $api_instance->oBAuthoritiesSearchPost($sCIM 2.0 Search Request Message);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OBAuthoritiesApi->oBAuthoritiesSearchPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OBAuthoritiesApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OBAuthoritiesApi->new();
my $sCIM 2.0 Search Request Message = WWW::SwaggerClient::Object::SearchRequest->new(); # SearchRequest | 

eval { 
    my $result = $api_instance->oBAuthoritiesSearchPost(sCIM 2.0 Search Request Message => $sCIM 2.0 Search Request Message);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OBAuthoritiesApi->oBAuthoritiesSearchPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OBAuthoritiesApi()
sCIM 2.0 Search Request Message =  # SearchRequest |  (optional)

try: 
    # Search for one or more resources using HTTP POST
    api_response = api_instance.o_b_authorities_search_post(sCIM 2.0 Search Request Message=sCIM 2.0 Search Request Message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OBAuthoritiesApi->oBAuthoritiesSearchPost: %s\n" % e)

Parameters

Body parameters
Name Description
sCIM 2.0 Search Request Message

Responses

Status: 200 - SCIM 2.0 List Response Message

Status: default - An error occurred while executing the operation


OBQualifiedTrustServiceProviders

oBQualifiedTrustServiceProvidersGet

Search for one or more resources


/OBQualifiedTrustServiceProviders

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/OBQualifiedTrustServiceProviders?attributes=&excludedAttributes=&filter=&sortBy=&sortOrder=&startIndex=&count="
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OBQualifiedTrustServiceProvidersApi;

import java.io.File;
import java.util.*;

public class OBQualifiedTrustServiceProvidersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        OBQualifiedTrustServiceProvidersApi apiInstance = new OBQualifiedTrustServiceProvidersApi();
        String attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
        String excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
        String filter = filter_example; // String | The filter string used to request a subset of resources.
        String sortBy = sortBy_example; // String | A string indicating the attribute whose value shall be used to order the returned responses.
        String sortOrder = sortOrder_example; // String | A string indicating the order in which the 'sortBy' parameter is applied.
        Integer startIndex = 56; // Integer | An integer indicating the 1-based index of the first query result.
        Integer count = 56; // Integer | An integer indicating the desired maximum number of query results per page.
        try {
            inline_response_200_2 result = apiInstance.oBQualifiedTrustServiceProvidersGet(attributes, excludedAttributes, filter, sortBy, sortOrder, startIndex, count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBQualifiedTrustServiceProvidersApi#oBQualifiedTrustServiceProvidersGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OBQualifiedTrustServiceProvidersApi;

public class OBQualifiedTrustServiceProvidersApiExample {

    public static void main(String[] args) {
        OBQualifiedTrustServiceProvidersApi apiInstance = new OBQualifiedTrustServiceProvidersApi();
        String attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
        String excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
        String filter = filter_example; // String | The filter string used to request a subset of resources.
        String sortBy = sortBy_example; // String | A string indicating the attribute whose value shall be used to order the returned responses.
        String sortOrder = sortOrder_example; // String | A string indicating the order in which the 'sortBy' parameter is applied.
        Integer startIndex = 56; // Integer | An integer indicating the 1-based index of the first query result.
        Integer count = 56; // Integer | An integer indicating the desired maximum number of query results per page.
        try {
            inline_response_200_2 result = apiInstance.oBQualifiedTrustServiceProvidersGet(attributes, excludedAttributes, filter, sortBy, sortOrder, startIndex, count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBQualifiedTrustServiceProvidersApi#oBQualifiedTrustServiceProvidersGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *attributes = attributes_example; // A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional)
String *excludedAttributes = excludedAttributes_example; // A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional)
String *filter = filter_example; // The filter string used to request a subset of resources. (optional)
String *sortBy = sortBy_example; // A string indicating the attribute whose value shall be used to order the returned responses. (optional)
String *sortOrder = sortOrder_example; // A string indicating the order in which the 'sortBy' parameter is applied. (optional)
Integer *startIndex = 56; // An integer indicating the 1-based index of the first query result. (optional)
Integer *count = 56; // An integer indicating the desired maximum number of query results per page. (optional)

OBQualifiedTrustServiceProvidersApi *apiInstance = [[OBQualifiedTrustServiceProvidersApi alloc] init];

// Search for one or more resources
[apiInstance oBQualifiedTrustServiceProvidersGetWith:attributes
    excludedAttributes:excludedAttributes
    filter:filter
    sortBy:sortBy
    sortOrder:sortOrder
    startIndex:startIndex
    count:count
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OBQualifiedTrustServiceProvidersApi()

var opts = { 
  'attributes': attributes_example, // {String} A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
  'excludedAttributes': excludedAttributes_example // {String} A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
  'filter': filter_example, // {String} The filter string used to request a subset of resources.
  'sortBy': sortBy_example, // {String} A string indicating the attribute whose value shall be used to order the returned responses.
  'sortOrder': sortOrder_example, // {String} A string indicating the order in which the 'sortBy' parameter is applied.
  'startIndex': 56, // {Integer} An integer indicating the 1-based index of the first query result.
  'count': 56 // {Integer} An integer indicating the desired maximum number of query results per page.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.oBQualifiedTrustServiceProvidersGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class oBQualifiedTrustServiceProvidersGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OBQualifiedTrustServiceProvidersApi();
            var attributes = attributes_example;  // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional) 
            var excludedAttributes = excludedAttributes_example;  // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional) 
            var filter = filter_example;  // String | The filter string used to request a subset of resources. (optional) 
            var sortBy = sortBy_example;  // String | A string indicating the attribute whose value shall be used to order the returned responses. (optional) 
            var sortOrder = sortOrder_example;  // String | A string indicating the order in which the 'sortBy' parameter is applied. (optional) 
            var startIndex = 56;  // Integer | An integer indicating the 1-based index of the first query result. (optional) 
            var count = 56;  // Integer | An integer indicating the desired maximum number of query results per page. (optional) 

            try
            {
                // Search for one or more resources
                inline_response_200_2 result = apiInstance.oBQualifiedTrustServiceProvidersGet(attributes, excludedAttributes, filter, sortBy, sortOrder, startIndex, count);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OBQualifiedTrustServiceProvidersApi.oBQualifiedTrustServiceProvidersGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OBQualifiedTrustServiceProvidersApi();
$attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
$excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
$filter = filter_example; // String | The filter string used to request a subset of resources.
$sortBy = sortBy_example; // String | A string indicating the attribute whose value shall be used to order the returned responses.
$sortOrder = sortOrder_example; // String | A string indicating the order in which the 'sortBy' parameter is applied.
$startIndex = 56; // Integer | An integer indicating the 1-based index of the first query result.
$count = 56; // Integer | An integer indicating the desired maximum number of query results per page.

try {
    $result = $api_instance->oBQualifiedTrustServiceProvidersGet($attributes, $excludedAttributes, $filter, $sortBy, $sortOrder, $startIndex, $count);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OBQualifiedTrustServiceProvidersApi->oBQualifiedTrustServiceProvidersGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OBQualifiedTrustServiceProvidersApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OBQualifiedTrustServiceProvidersApi->new();
my $attributes = attributes_example; # String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
my $excludedAttributes = excludedAttributes_example; # String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
my $filter = filter_example; # String | The filter string used to request a subset of resources.
my $sortBy = sortBy_example; # String | A string indicating the attribute whose value shall be used to order the returned responses.
my $sortOrder = sortOrder_example; # String | A string indicating the order in which the 'sortBy' parameter is applied.
my $startIndex = 56; # Integer | An integer indicating the 1-based index of the first query result.
my $count = 56; # Integer | An integer indicating the desired maximum number of query results per page.

eval { 
    my $result = $api_instance->oBQualifiedTrustServiceProvidersGet(attributes => $attributes, excludedAttributes => $excludedAttributes, filter => $filter, sortBy => $sortBy, sortOrder => $sortOrder, startIndex => $startIndex, count => $count);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OBQualifiedTrustServiceProvidersApi->oBQualifiedTrustServiceProvidersGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OBQualifiedTrustServiceProvidersApi()
attributes = attributes_example # String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional)
excludedAttributes = excludedAttributes_example # String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional)
filter = filter_example # String | The filter string used to request a subset of resources. (optional)
sortBy = sortBy_example # String | A string indicating the attribute whose value shall be used to order the returned responses. (optional)
sortOrder = sortOrder_example # String | A string indicating the order in which the 'sortBy' parameter is applied. (optional)
startIndex = 56 # Integer | An integer indicating the 1-based index of the first query result. (optional)
count = 56 # Integer | An integer indicating the desired maximum number of query results per page. (optional)

try: 
    # Search for one or more resources
    api_response = api_instance.o_b_qualified_trust_service_providers_get(attributes=attributes, excludedAttributes=excludedAttributes, filter=filter, sortBy=sortBy, sortOrder=sortOrder, startIndex=startIndex, count=count)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OBQualifiedTrustServiceProvidersApi->oBQualifiedTrustServiceProvidersGet: %s\n" % e)

Parameters

Query parameters
Name Description
attributes
String
A comma separated list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default. 'excludedAttributes' must not also be specified if this is specified.
excludedAttributes
String
A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
filter
String
The filter string used to request a subset of resources.
sortBy
String
A string indicating the attribute whose value shall be used to order the returned responses.
sortOrder
String
A string indicating the order in which the 'sortBy' parameter is applied.
startIndex
Integer
An integer indicating the 1-based index of the first query result.
count
Integer
An integer indicating the desired maximum number of query results per page.

Responses

Status: 200 - SCIM 2.0 List Response Message

Status: default - An error occurred while executing the operation


oBQualifiedTrustServiceProvidersIdGet

Retrieve the resource


/OBQualifiedTrustServiceProviders/{id}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/OBQualifiedTrustServiceProviders/{id}?attributes=&excludedAttributes="
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OBQualifiedTrustServiceProvidersApi;

import java.io.File;
import java.util.*;

public class OBQualifiedTrustServiceProvidersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        OBQualifiedTrustServiceProvidersApi apiInstance = new OBQualifiedTrustServiceProvidersApi();
        String id = id_example; // String | The resource identifier (value of the 'id' attribute).
        String attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
        String excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
        try {
            OBQualifiedTrustServiceProviders result = apiInstance.oBQualifiedTrustServiceProvidersIdGet(id, attributes, excludedAttributes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBQualifiedTrustServiceProvidersApi#oBQualifiedTrustServiceProvidersIdGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OBQualifiedTrustServiceProvidersApi;

public class OBQualifiedTrustServiceProvidersApiExample {

    public static void main(String[] args) {
        OBQualifiedTrustServiceProvidersApi apiInstance = new OBQualifiedTrustServiceProvidersApi();
        String id = id_example; // String | The resource identifier (value of the 'id' attribute).
        String attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
        String excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
        try {
            OBQualifiedTrustServiceProviders result = apiInstance.oBQualifiedTrustServiceProvidersIdGet(id, attributes, excludedAttributes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBQualifiedTrustServiceProvidersApi#oBQualifiedTrustServiceProvidersIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *id = id_example; // The resource identifier (value of the 'id' attribute).
String *attributes = attributes_example; // A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional)
String *excludedAttributes = excludedAttributes_example; // A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional)

OBQualifiedTrustServiceProvidersApi *apiInstance = [[OBQualifiedTrustServiceProvidersApi alloc] init];

// Retrieve the resource
[apiInstance oBQualifiedTrustServiceProvidersIdGetWith:id
    attributes:attributes
    excludedAttributes:excludedAttributes
              completionHandler: ^(OBQualifiedTrustServiceProviders output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OBQualifiedTrustServiceProvidersApi()

var id = id_example; // {String} The resource identifier (value of the 'id' attribute).

var opts = { 
  'attributes': attributes_example, // {String} A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
  'excludedAttributes': excludedAttributes_example // {String} A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.oBQualifiedTrustServiceProvidersIdGet(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class oBQualifiedTrustServiceProvidersIdGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OBQualifiedTrustServiceProvidersApi();
            var id = id_example;  // String | The resource identifier (value of the 'id' attribute).
            var attributes = attributes_example;  // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional) 
            var excludedAttributes = excludedAttributes_example;  // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional) 

            try
            {
                // Retrieve the resource
                OBQualifiedTrustServiceProviders result = apiInstance.oBQualifiedTrustServiceProvidersIdGet(id, attributes, excludedAttributes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OBQualifiedTrustServiceProvidersApi.oBQualifiedTrustServiceProvidersIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OBQualifiedTrustServiceProvidersApi();
$id = id_example; // String | The resource identifier (value of the 'id' attribute).
$attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
$excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.

try {
    $result = $api_instance->oBQualifiedTrustServiceProvidersIdGet($id, $attributes, $excludedAttributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OBQualifiedTrustServiceProvidersApi->oBQualifiedTrustServiceProvidersIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OBQualifiedTrustServiceProvidersApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OBQualifiedTrustServiceProvidersApi->new();
my $id = id_example; # String | The resource identifier (value of the 'id' attribute).
my $attributes = attributes_example; # String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
my $excludedAttributes = excludedAttributes_example; # String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.

eval { 
    my $result = $api_instance->oBQualifiedTrustServiceProvidersIdGet(id => $id, attributes => $attributes, excludedAttributes => $excludedAttributes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OBQualifiedTrustServiceProvidersApi->oBQualifiedTrustServiceProvidersIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OBQualifiedTrustServiceProvidersApi()
id = id_example # String | The resource identifier (value of the 'id' attribute).
attributes = attributes_example # String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional)
excludedAttributes = excludedAttributes_example # String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional)

try: 
    # Retrieve the resource
    api_response = api_instance.o_b_qualified_trust_service_providers_id_get(id, attributes=attributes, excludedAttributes=excludedAttributes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OBQualifiedTrustServiceProvidersApi->oBQualifiedTrustServiceProvidersIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
The resource identifier (value of the 'id' attribute).
Required
Query parameters
Name Description
attributes
String
A comma separated list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default. 'excludedAttributes' must not also be specified if this is specified.
excludedAttributes
String
A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.

Responses

Status: 200 - The retrieved resource is included in the response body

Status: default - An error occurred while executing the operation


oBQualifiedTrustServiceProvidersSearchPost

Search for one or more resources using HTTP POST

Useful for executing searches without passing parameters that may contain sensitive information on the URL.


/OBQualifiedTrustServiceProviders/.search

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/OBQualifiedTrustServiceProviders/.search"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OBQualifiedTrustServiceProvidersApi;

import java.io.File;
import java.util.*;

public class OBQualifiedTrustServiceProvidersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        OBQualifiedTrustServiceProvidersApi apiInstance = new OBQualifiedTrustServiceProvidersApi();
        SearchRequest sCIM 2.0 Search Request Message = ; // SearchRequest | 
        try {
            inline_response_200_2 result = apiInstance.oBQualifiedTrustServiceProvidersSearchPost(sCIM 2.0 Search Request Message);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBQualifiedTrustServiceProvidersApi#oBQualifiedTrustServiceProvidersSearchPost");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OBQualifiedTrustServiceProvidersApi;

public class OBQualifiedTrustServiceProvidersApiExample {

    public static void main(String[] args) {
        OBQualifiedTrustServiceProvidersApi apiInstance = new OBQualifiedTrustServiceProvidersApi();
        SearchRequest sCIM 2.0 Search Request Message = ; // SearchRequest | 
        try {
            inline_response_200_2 result = apiInstance.oBQualifiedTrustServiceProvidersSearchPost(sCIM 2.0 Search Request Message);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBQualifiedTrustServiceProvidersApi#oBQualifiedTrustServiceProvidersSearchPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

SearchRequest *sCIM 2.0 Search Request Message = ; //  (optional)

OBQualifiedTrustServiceProvidersApi *apiInstance = [[OBQualifiedTrustServiceProvidersApi alloc] init];

// Search for one or more resources using HTTP POST
[apiInstance oBQualifiedTrustServiceProvidersSearchPostWith:sCIM 2.0 Search Request Message
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OBQualifiedTrustServiceProvidersApi()

var opts = { 
  'sCIM 2.0 Search Request Message':  // {SearchRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.oBQualifiedTrustServiceProvidersSearchPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class oBQualifiedTrustServiceProvidersSearchPostExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OBQualifiedTrustServiceProvidersApi();
            var sCIM 2.0 Search Request Message = new SearchRequest(); // SearchRequest |  (optional) 

            try
            {
                // Search for one or more resources using HTTP POST
                inline_response_200_2 result = apiInstance.oBQualifiedTrustServiceProvidersSearchPost(sCIM 2.0 Search Request Message);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OBQualifiedTrustServiceProvidersApi.oBQualifiedTrustServiceProvidersSearchPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OBQualifiedTrustServiceProvidersApi();
$sCIM 2.0 Search Request Message = ; // SearchRequest | 

try {
    $result = $api_instance->oBQualifiedTrustServiceProvidersSearchPost($sCIM 2.0 Search Request Message);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OBQualifiedTrustServiceProvidersApi->oBQualifiedTrustServiceProvidersSearchPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OBQualifiedTrustServiceProvidersApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OBQualifiedTrustServiceProvidersApi->new();
my $sCIM 2.0 Search Request Message = WWW::SwaggerClient::Object::SearchRequest->new(); # SearchRequest | 

eval { 
    my $result = $api_instance->oBQualifiedTrustServiceProvidersSearchPost(sCIM 2.0 Search Request Message => $sCIM 2.0 Search Request Message);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OBQualifiedTrustServiceProvidersApi->oBQualifiedTrustServiceProvidersSearchPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OBQualifiedTrustServiceProvidersApi()
sCIM 2.0 Search Request Message =  # SearchRequest |  (optional)

try: 
    # Search for one or more resources using HTTP POST
    api_response = api_instance.o_b_qualified_trust_service_providers_search_post(sCIM 2.0 Search Request Message=sCIM 2.0 Search Request Message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OBQualifiedTrustServiceProvidersApi->oBQualifiedTrustServiceProvidersSearchPost: %s\n" % e)

Parameters

Body parameters
Name Description
sCIM 2.0 Search Request Message

Responses

Status: 200 - SCIM 2.0 List Response Message

Status: default - An error occurred while executing the operation


OBThirdPartyProviders

oBThirdPartyProvidersGet

Search for one or more resources


/OBThirdPartyProviders

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/OBThirdPartyProviders?attributes=&excludedAttributes=&filter=&sortBy=&sortOrder=&startIndex=&count="
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OBThirdPartyProvidersApi;

import java.io.File;
import java.util.*;

public class OBThirdPartyProvidersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        OBThirdPartyProvidersApi apiInstance = new OBThirdPartyProvidersApi();
        String attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
        String excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
        String filter = filter_example; // String | The filter string used to request a subset of resources.
        String sortBy = sortBy_example; // String | A string indicating the attribute whose value shall be used to order the returned responses.
        String sortOrder = sortOrder_example; // String | A string indicating the order in which the 'sortBy' parameter is applied.
        Integer startIndex = 56; // Integer | An integer indicating the 1-based index of the first query result.
        Integer count = 56; // Integer | An integer indicating the desired maximum number of query results per page.
        try {
            inline_response_200_3 result = apiInstance.oBThirdPartyProvidersGet(attributes, excludedAttributes, filter, sortBy, sortOrder, startIndex, count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBThirdPartyProvidersApi#oBThirdPartyProvidersGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OBThirdPartyProvidersApi;

public class OBThirdPartyProvidersApiExample {

    public static void main(String[] args) {
        OBThirdPartyProvidersApi apiInstance = new OBThirdPartyProvidersApi();
        String attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
        String excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
        String filter = filter_example; // String | The filter string used to request a subset of resources.
        String sortBy = sortBy_example; // String | A string indicating the attribute whose value shall be used to order the returned responses.
        String sortOrder = sortOrder_example; // String | A string indicating the order in which the 'sortBy' parameter is applied.
        Integer startIndex = 56; // Integer | An integer indicating the 1-based index of the first query result.
        Integer count = 56; // Integer | An integer indicating the desired maximum number of query results per page.
        try {
            inline_response_200_3 result = apiInstance.oBThirdPartyProvidersGet(attributes, excludedAttributes, filter, sortBy, sortOrder, startIndex, count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBThirdPartyProvidersApi#oBThirdPartyProvidersGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *attributes = attributes_example; // A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional)
String *excludedAttributes = excludedAttributes_example; // A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional)
String *filter = filter_example; // The filter string used to request a subset of resources. (optional)
String *sortBy = sortBy_example; // A string indicating the attribute whose value shall be used to order the returned responses. (optional)
String *sortOrder = sortOrder_example; // A string indicating the order in which the 'sortBy' parameter is applied. (optional)
Integer *startIndex = 56; // An integer indicating the 1-based index of the first query result. (optional)
Integer *count = 56; // An integer indicating the desired maximum number of query results per page. (optional)

OBThirdPartyProvidersApi *apiInstance = [[OBThirdPartyProvidersApi alloc] init];

// Search for one or more resources
[apiInstance oBThirdPartyProvidersGetWith:attributes
    excludedAttributes:excludedAttributes
    filter:filter
    sortBy:sortBy
    sortOrder:sortOrder
    startIndex:startIndex
    count:count
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OBThirdPartyProvidersApi()

var opts = { 
  'attributes': attributes_example, // {String} A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
  'excludedAttributes': excludedAttributes_example // {String} A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
  'filter': filter_example, // {String} The filter string used to request a subset of resources.
  'sortBy': sortBy_example, // {String} A string indicating the attribute whose value shall be used to order the returned responses.
  'sortOrder': sortOrder_example, // {String} A string indicating the order in which the 'sortBy' parameter is applied.
  'startIndex': 56, // {Integer} An integer indicating the 1-based index of the first query result.
  'count': 56 // {Integer} An integer indicating the desired maximum number of query results per page.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.oBThirdPartyProvidersGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class oBThirdPartyProvidersGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OBThirdPartyProvidersApi();
            var attributes = attributes_example;  // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional) 
            var excludedAttributes = excludedAttributes_example;  // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional) 
            var filter = filter_example;  // String | The filter string used to request a subset of resources. (optional) 
            var sortBy = sortBy_example;  // String | A string indicating the attribute whose value shall be used to order the returned responses. (optional) 
            var sortOrder = sortOrder_example;  // String | A string indicating the order in which the 'sortBy' parameter is applied. (optional) 
            var startIndex = 56;  // Integer | An integer indicating the 1-based index of the first query result. (optional) 
            var count = 56;  // Integer | An integer indicating the desired maximum number of query results per page. (optional) 

            try
            {
                // Search for one or more resources
                inline_response_200_3 result = apiInstance.oBThirdPartyProvidersGet(attributes, excludedAttributes, filter, sortBy, sortOrder, startIndex, count);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OBThirdPartyProvidersApi.oBThirdPartyProvidersGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OBThirdPartyProvidersApi();
$attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
$excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
$filter = filter_example; // String | The filter string used to request a subset of resources.
$sortBy = sortBy_example; // String | A string indicating the attribute whose value shall be used to order the returned responses.
$sortOrder = sortOrder_example; // String | A string indicating the order in which the 'sortBy' parameter is applied.
$startIndex = 56; // Integer | An integer indicating the 1-based index of the first query result.
$count = 56; // Integer | An integer indicating the desired maximum number of query results per page.

try {
    $result = $api_instance->oBThirdPartyProvidersGet($attributes, $excludedAttributes, $filter, $sortBy, $sortOrder, $startIndex, $count);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OBThirdPartyProvidersApi->oBThirdPartyProvidersGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OBThirdPartyProvidersApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OBThirdPartyProvidersApi->new();
my $attributes = attributes_example; # String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
my $excludedAttributes = excludedAttributes_example; # String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
my $filter = filter_example; # String | The filter string used to request a subset of resources.
my $sortBy = sortBy_example; # String | A string indicating the attribute whose value shall be used to order the returned responses.
my $sortOrder = sortOrder_example; # String | A string indicating the order in which the 'sortBy' parameter is applied.
my $startIndex = 56; # Integer | An integer indicating the 1-based index of the first query result.
my $count = 56; # Integer | An integer indicating the desired maximum number of query results per page.

eval { 
    my $result = $api_instance->oBThirdPartyProvidersGet(attributes => $attributes, excludedAttributes => $excludedAttributes, filter => $filter, sortBy => $sortBy, sortOrder => $sortOrder, startIndex => $startIndex, count => $count);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OBThirdPartyProvidersApi->oBThirdPartyProvidersGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OBThirdPartyProvidersApi()
attributes = attributes_example # String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional)
excludedAttributes = excludedAttributes_example # String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional)
filter = filter_example # String | The filter string used to request a subset of resources. (optional)
sortBy = sortBy_example # String | A string indicating the attribute whose value shall be used to order the returned responses. (optional)
sortOrder = sortOrder_example # String | A string indicating the order in which the 'sortBy' parameter is applied. (optional)
startIndex = 56 # Integer | An integer indicating the 1-based index of the first query result. (optional)
count = 56 # Integer | An integer indicating the desired maximum number of query results per page. (optional)

try: 
    # Search for one or more resources
    api_response = api_instance.o_b_third_party_providers_get(attributes=attributes, excludedAttributes=excludedAttributes, filter=filter, sortBy=sortBy, sortOrder=sortOrder, startIndex=startIndex, count=count)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OBThirdPartyProvidersApi->oBThirdPartyProvidersGet: %s\n" % e)

Parameters

Query parameters
Name Description
attributes
String
A comma separated list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default. 'excludedAttributes' must not also be specified if this is specified.
excludedAttributes
String
A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
filter
String
The filter string used to request a subset of resources.
sortBy
String
A string indicating the attribute whose value shall be used to order the returned responses.
sortOrder
String
A string indicating the order in which the 'sortBy' parameter is applied.
startIndex
Integer
An integer indicating the 1-based index of the first query result.
count
Integer
An integer indicating the desired maximum number of query results per page.

Responses

Status: 200 - SCIM 2.0 List Response Message

Status: default - An error occurred while executing the operation


oBThirdPartyProvidersIdGet

Retrieve the resource


/OBThirdPartyProviders/{id}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/OBThirdPartyProviders/{id}?attributes=&excludedAttributes="
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OBThirdPartyProvidersApi;

import java.io.File;
import java.util.*;

public class OBThirdPartyProvidersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        OBThirdPartyProvidersApi apiInstance = new OBThirdPartyProvidersApi();
        String id = id_example; // String | The resource identifier (value of the 'id' attribute).
        String attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
        String excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
        try {
            OBThirdPartyProviders result = apiInstance.oBThirdPartyProvidersIdGet(id, attributes, excludedAttributes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBThirdPartyProvidersApi#oBThirdPartyProvidersIdGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OBThirdPartyProvidersApi;

public class OBThirdPartyProvidersApiExample {

    public static void main(String[] args) {
        OBThirdPartyProvidersApi apiInstance = new OBThirdPartyProvidersApi();
        String id = id_example; // String | The resource identifier (value of the 'id' attribute).
        String attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
        String excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
        try {
            OBThirdPartyProviders result = apiInstance.oBThirdPartyProvidersIdGet(id, attributes, excludedAttributes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBThirdPartyProvidersApi#oBThirdPartyProvidersIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *id = id_example; // The resource identifier (value of the 'id' attribute).
String *attributes = attributes_example; // A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional)
String *excludedAttributes = excludedAttributes_example; // A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional)

OBThirdPartyProvidersApi *apiInstance = [[OBThirdPartyProvidersApi alloc] init];

// Retrieve the resource
[apiInstance oBThirdPartyProvidersIdGetWith:id
    attributes:attributes
    excludedAttributes:excludedAttributes
              completionHandler: ^(OBThirdPartyProviders output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OBThirdPartyProvidersApi()

var id = id_example; // {String} The resource identifier (value of the 'id' attribute).

var opts = { 
  'attributes': attributes_example, // {String} A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
  'excludedAttributes': excludedAttributes_example // {String} A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.oBThirdPartyProvidersIdGet(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class oBThirdPartyProvidersIdGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OBThirdPartyProvidersApi();
            var id = id_example;  // String | The resource identifier (value of the 'id' attribute).
            var attributes = attributes_example;  // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional) 
            var excludedAttributes = excludedAttributes_example;  // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional) 

            try
            {
                // Retrieve the resource
                OBThirdPartyProviders result = apiInstance.oBThirdPartyProvidersIdGet(id, attributes, excludedAttributes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OBThirdPartyProvidersApi.oBThirdPartyProvidersIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OBThirdPartyProvidersApi();
$id = id_example; // String | The resource identifier (value of the 'id' attribute).
$attributes = attributes_example; // String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
$excludedAttributes = excludedAttributes_example; // String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.

try {
    $result = $api_instance->oBThirdPartyProvidersIdGet($id, $attributes, $excludedAttributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OBThirdPartyProvidersApi->oBThirdPartyProvidersIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OBThirdPartyProvidersApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OBThirdPartyProvidersApi->new();
my $id = id_example; # String | The resource identifier (value of the 'id' attribute).
my $attributes = attributes_example; # String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified.
my $excludedAttributes = excludedAttributes_example; # String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.

eval { 
    my $result = $api_instance->oBThirdPartyProvidersIdGet(id => $id, attributes => $attributes, excludedAttributes => $excludedAttributes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OBThirdPartyProvidersApi->oBThirdPartyProvidersIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OBThirdPartyProvidersApi()
id = id_example # String | The resource identifier (value of the 'id' attribute).
attributes = attributes_example # String | A comma separated list of strings indicating the names of resource
attributes to return in the response, overriding the set of attributes that
would be returned by default. 'excludedAttributes' must not also be specified
if this is specified. (optional)
excludedAttributes = excludedAttributes_example # String | A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified. (optional)

try: 
    # Retrieve the resource
    api_response = api_instance.o_b_third_party_providers_id_get(id, attributes=attributes, excludedAttributes=excludedAttributes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OBThirdPartyProvidersApi->oBThirdPartyProvidersIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
The resource identifier (value of the 'id' attribute).
Required
Query parameters
Name Description
attributes
String
A comma separated list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default. 'excludedAttributes' must not also be specified if this is specified.
excludedAttributes
String
A comma separated list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. 'attributes' must not also be specified if this is specified.

Responses

Status: 200 - The retrieved resource is included in the response body

Status: default - An error occurred while executing the operation


oBThirdPartyProvidersSearchPost

Search for one or more resources using HTTP POST

Useful for executing searches without passing parameters that may contain sensitive information on the URL.


/OBThirdPartyProviders/.search

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/OBThirdPartyProviders/.search"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OBThirdPartyProvidersApi;

import java.io.File;
import java.util.*;

public class OBThirdPartyProvidersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        OBThirdPartyProvidersApi apiInstance = new OBThirdPartyProvidersApi();
        SearchRequest sCIM 2.0 Search Request Message = ; // SearchRequest | 
        try {
            inline_response_200_3 result = apiInstance.oBThirdPartyProvidersSearchPost(sCIM 2.0 Search Request Message);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBThirdPartyProvidersApi#oBThirdPartyProvidersSearchPost");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OBThirdPartyProvidersApi;

public class OBThirdPartyProvidersApiExample {

    public static void main(String[] args) {
        OBThirdPartyProvidersApi apiInstance = new OBThirdPartyProvidersApi();
        SearchRequest sCIM 2.0 Search Request Message = ; // SearchRequest | 
        try {
            inline_response_200_3 result = apiInstance.oBThirdPartyProvidersSearchPost(sCIM 2.0 Search Request Message);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OBThirdPartyProvidersApi#oBThirdPartyProvidersSearchPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

SearchRequest *sCIM 2.0 Search Request Message = ; //  (optional)

OBThirdPartyProvidersApi *apiInstance = [[OBThirdPartyProvidersApi alloc] init];

// Search for one or more resources using HTTP POST
[apiInstance oBThirdPartyProvidersSearchPostWith:sCIM 2.0 Search Request Message
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OBThirdPartyProvidersApi()

var opts = { 
  'sCIM 2.0 Search Request Message':  // {SearchRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.oBThirdPartyProvidersSearchPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class oBThirdPartyProvidersSearchPostExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OBThirdPartyProvidersApi();
            var sCIM 2.0 Search Request Message = new SearchRequest(); // SearchRequest |  (optional) 

            try
            {
                // Search for one or more resources using HTTP POST
                inline_response_200_3 result = apiInstance.oBThirdPartyProvidersSearchPost(sCIM 2.0 Search Request Message);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OBThirdPartyProvidersApi.oBThirdPartyProvidersSearchPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OBThirdPartyProvidersApi();
$sCIM 2.0 Search Request Message = ; // SearchRequest | 

try {
    $result = $api_instance->oBThirdPartyProvidersSearchPost($sCIM 2.0 Search Request Message);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OBThirdPartyProvidersApi->oBThirdPartyProvidersSearchPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OBThirdPartyProvidersApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OBThirdPartyProvidersApi->new();
my $sCIM 2.0 Search Request Message = WWW::SwaggerClient::Object::SearchRequest->new(); # SearchRequest | 

eval { 
    my $result = $api_instance->oBThirdPartyProvidersSearchPost(sCIM 2.0 Search Request Message => $sCIM 2.0 Search Request Message);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OBThirdPartyProvidersApi->oBThirdPartyProvidersSearchPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OBThirdPartyProvidersApi()
sCIM 2.0 Search Request Message =  # SearchRequest |  (optional)

try: 
    # Search for one or more resources using HTTP POST
    api_response = api_instance.o_b_third_party_providers_search_post(sCIM 2.0 Search Request Message=sCIM 2.0 Search Request Message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OBThirdPartyProvidersApi->oBThirdPartyProvidersSearchPost: %s\n" % e)

Parameters

Body parameters
Name Description
sCIM 2.0 Search Request Message

Responses

Status: 200 - SCIM 2.0 List Response Message

Status: default - An error occurred while executing the operation


Offers

getAccountsAccountIdOffers

Get Offers


/accounts/{AccountId}/offers

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/accounts/{AccountId}/offers"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OffersApi;

import java.io.File;
import java.util.*;

public class OffersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        OffersApi apiInstance = new OffersApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadOffer1 result = apiInstance.getAccountsAccountIdOffers(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#getAccountsAccountIdOffers");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OffersApi;

public class OffersApiExample {

    public static void main(String[] args) {
        OffersApi apiInstance = new OffersApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadOffer1 result = apiInstance.getAccountsAccountIdOffers(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#getAccountsAccountIdOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

OffersApi *apiInstance = [[OffersApi alloc] init];

// Get Offers
[apiInstance getAccountsAccountIdOffersWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadOffer1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OffersApi()

var accountId = accountId_example; // {String} AccountId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdOffers(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdOffersExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OffersApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Offers
                OBReadOffer1 result = apiInstance.getAccountsAccountIdOffers(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OffersApi.getAccountsAccountIdOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OffersApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getAccountsAccountIdOffers($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OffersApi->getAccountsAccountIdOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OffersApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OffersApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getAccountsAccountIdOffers(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OffersApi->getAccountsAccountIdOffers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OffersApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Offers
    api_response = api_instance.get_accounts_account_id_offers(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OffersApi->getAccountsAccountIdOffers: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Offers Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getOffers

Get Offers


/offers

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/offers"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OffersApi;

import java.io.File;
import java.util.*;

public class OffersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        OffersApi apiInstance = new OffersApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadOffer1 result = apiInstance.getOffers(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#getOffers");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OffersApi;

public class OffersApiExample {

    public static void main(String[] args) {
        OffersApi apiInstance = new OffersApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadOffer1 result = apiInstance.getOffers(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OffersApi#getOffers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

OffersApi *apiInstance = [[OffersApi alloc] init];

// Get Offers
[apiInstance getOffersWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadOffer1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OffersApi()

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOffers(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOffersExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OffersApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Offers
                OBReadOffer1 result = apiInstance.getOffers(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OffersApi.getOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OffersApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getOffers($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OffersApi->getOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OffersApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OffersApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getOffers(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OffersApi->getOffers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OffersApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Offers
    api_response = api_instance.get_offers(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OffersApi->getOffers: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Offers Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

OrganisationCertificates

organisationOrganisationTypeOrganisationIdCertificateGet

Get the certificates for the given organisation


/organisation/{OrganisationType}/{OrganisationId}/certificate

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/certificate"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OrganisationCertificatesApi;

import java.io.File;
import java.util.*;

public class OrganisationCertificatesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
        OAuth OAuth2SecurityReadOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadOps");
        OAuth2SecurityReadOps.setAccessToken("YOUR ACCESS TOKEN");

        OrganisationCertificatesApi apiInstance = new OrganisationCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdCertificateGet(organisationType, organisationId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationCertificatesApi#organisationOrganisationTypeOrganisationIdCertificateGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OrganisationCertificatesApi;

public class OrganisationCertificatesApiExample {

    public static void main(String[] args) {
        OrganisationCertificatesApi apiInstance = new OrganisationCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdCertificateGet(organisationType, organisationId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationCertificatesApi#organisationOrganisationTypeOrganisationIdCertificateGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID

OrganisationCertificatesApi *apiInstance = [[OrganisationCertificatesApi alloc] init];

// Get the certificates for the given organisation
[apiInstance organisationOrganisationTypeOrganisationIdCertificateGetWith:organisationType
    organisationId:organisationId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
var OAuth2SecurityReadOps = defaultClient.authentications['OAuth2SecurityReadOps'];
OAuth2SecurityReadOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OrganisationCertificatesApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdCertificateGet(organisationType, organisationId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdCertificateGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrganisationCertificatesApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID

            try
            {
                // Get the certificates for the given organisation
                apiInstance.organisationOrganisationTypeOrganisationIdCertificateGet(organisationType, organisationId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganisationCertificatesApi.organisationOrganisationTypeOrganisationIdCertificateGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OrganisationCertificatesApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID

try {
    $api_instance->organisationOrganisationTypeOrganisationIdCertificateGet($organisationType, $organisationId);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationCertificatesApi->organisationOrganisationTypeOrganisationIdCertificateGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganisationCertificatesApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OrganisationCertificatesApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdCertificateGet(organisationType => $organisationType, organisationId => $organisationId);
};
if ($@) {
    warn "Exception when calling OrganisationCertificatesApi->organisationOrganisationTypeOrganisationIdCertificateGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OrganisationCertificatesApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID

try: 
    # Get the certificates for the given organisation
    api_instance.organisation_organisation_type_organisation_id_certificate_get(organisationType, organisationId)
except ApiException as e:
    print("Exception when calling OrganisationCertificatesApi->organisationOrganisationTypeOrganisationIdCertificateGet: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required

Responses

Status: 200 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdDelete

Revoke or remove a certificate with the given CertificateOrKeyId


/organisation/{OrganisationType}/{OrganisationId}/certificate/kid/{CertificateOrKeyId}

Usage and SDK Samples

curl -X DELETE "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/certificate/kid/{CertificateOrKeyId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OrganisationCertificatesApi;

import java.io.File;
import java.util.*;

public class OrganisationCertificatesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
        OAuth OAuth2SecurityReadWriteOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadWriteOps");
        OAuth2SecurityReadWriteOps.setAccessToken("YOUR ACCESS TOKEN");

        OrganisationCertificatesApi apiInstance = new OrganisationCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String certificateOrKeyId = certificateOrKeyId_example; // String | The certificate or key Id
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdDelete(organisationType, organisationId, certificateOrKeyId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationCertificatesApi#organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdDelete");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OrganisationCertificatesApi;

public class OrganisationCertificatesApiExample {

    public static void main(String[] args) {
        OrganisationCertificatesApi apiInstance = new OrganisationCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String certificateOrKeyId = certificateOrKeyId_example; // String | The certificate or key Id
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdDelete(organisationType, organisationId, certificateOrKeyId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationCertificatesApi#organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadWriteOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *certificateOrKeyId = certificateOrKeyId_example; // The certificate or key Id

OrganisationCertificatesApi *apiInstance = [[OrganisationCertificatesApi alloc] init];

// Revoke or remove a certificate with the given CertificateOrKeyId
[apiInstance organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdDeleteWith:organisationType
    organisationId:organisationId
    certificateOrKeyId:certificateOrKeyId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
var OAuth2SecurityReadWriteOps = defaultClient.authentications['OAuth2SecurityReadWriteOps'];
OAuth2SecurityReadWriteOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OrganisationCertificatesApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var certificateOrKeyId = certificateOrKeyId_example; // {String} The certificate or key Id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdDelete(organisationType, organisationId, certificateOrKeyId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdDeleteExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrganisationCertificatesApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var certificateOrKeyId = certificateOrKeyId_example;  // String | The certificate or key Id

            try
            {
                // Revoke or remove a certificate with the given CertificateOrKeyId
                apiInstance.organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdDelete(organisationType, organisationId, certificateOrKeyId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganisationCertificatesApi.organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OrganisationCertificatesApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$certificateOrKeyId = certificateOrKeyId_example; // String | The certificate or key Id

try {
    $api_instance->organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdDelete($organisationType, $organisationId, $certificateOrKeyId);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationCertificatesApi->organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganisationCertificatesApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OrganisationCertificatesApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $certificateOrKeyId = certificateOrKeyId_example; # String | The certificate or key Id

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdDelete(organisationType => $organisationType, organisationId => $organisationId, certificateOrKeyId => $certificateOrKeyId);
};
if ($@) {
    warn "Exception when calling OrganisationCertificatesApi->organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OrganisationCertificatesApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
certificateOrKeyId = certificateOrKeyId_example # String | The certificate or key Id

try: 
    # Revoke or remove a certificate with the given CertificateOrKeyId
    api_instance.organisation_organisation_type_organisation_id_certificate_kid_certificate_or_key_id_delete(organisationType, organisationId, certificateOrKeyId)
except ApiException as e:
    print("Exception when calling OrganisationCertificatesApi->organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdDelete: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
CertificateOrKeyId*
String
The certificate or key Id
Required

Responses

Status: 204 - No Content

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdGet

Retrieve a certificate with the given CertificateOrKeyId


/organisation/{OrganisationType}/{OrganisationId}/certificate/kid/{CertificateOrKeyId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/certificate/kid/{CertificateOrKeyId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OrganisationCertificatesApi;

import java.io.File;
import java.util.*;

public class OrganisationCertificatesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
        OAuth OAuth2SecurityReadOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadOps");
        OAuth2SecurityReadOps.setAccessToken("YOUR ACCESS TOKEN");

        OrganisationCertificatesApi apiInstance = new OrganisationCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String certificateOrKeyId = certificateOrKeyId_example; // String | The certificate or key Id
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdGet(organisationType, organisationId, certificateOrKeyId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationCertificatesApi#organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OrganisationCertificatesApi;

public class OrganisationCertificatesApiExample {

    public static void main(String[] args) {
        OrganisationCertificatesApi apiInstance = new OrganisationCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String certificateOrKeyId = certificateOrKeyId_example; // String | The certificate or key Id
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdGet(organisationType, organisationId, certificateOrKeyId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationCertificatesApi#organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *certificateOrKeyId = certificateOrKeyId_example; // The certificate or key Id

OrganisationCertificatesApi *apiInstance = [[OrganisationCertificatesApi alloc] init];

// Retrieve a certificate with the given CertificateOrKeyId
[apiInstance organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdGetWith:organisationType
    organisationId:organisationId
    certificateOrKeyId:certificateOrKeyId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
var OAuth2SecurityReadOps = defaultClient.authentications['OAuth2SecurityReadOps'];
OAuth2SecurityReadOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OrganisationCertificatesApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var certificateOrKeyId = certificateOrKeyId_example; // {String} The certificate or key Id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdGet(organisationType, organisationId, certificateOrKeyId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrganisationCertificatesApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var certificateOrKeyId = certificateOrKeyId_example;  // String | The certificate or key Id

            try
            {
                // Retrieve a certificate with the given CertificateOrKeyId
                apiInstance.organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdGet(organisationType, organisationId, certificateOrKeyId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganisationCertificatesApi.organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OrganisationCertificatesApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$certificateOrKeyId = certificateOrKeyId_example; // String | The certificate or key Id

try {
    $api_instance->organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdGet($organisationType, $organisationId, $certificateOrKeyId);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationCertificatesApi->organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganisationCertificatesApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OrganisationCertificatesApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $certificateOrKeyId = certificateOrKeyId_example; # String | The certificate or key Id

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdGet(organisationType => $organisationType, organisationId => $organisationId, certificateOrKeyId => $certificateOrKeyId);
};
if ($@) {
    warn "Exception when calling OrganisationCertificatesApi->organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OrganisationCertificatesApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
certificateOrKeyId = certificateOrKeyId_example # String | The certificate or key Id

try: 
    # Retrieve a certificate with the given CertificateOrKeyId
    api_instance.organisation_organisation_type_organisation_id_certificate_kid_certificate_or_key_id_get(organisationType, organisationId, certificateOrKeyId)
except ApiException as e:
    print("Exception when calling OrganisationCertificatesApi->organisationOrganisationTypeOrganisationIdCertificateKidCertificateOrKeyIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
CertificateOrKeyId*
String
The certificate or key Id
Required

Responses

Status: 200 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypeGet

Get the certificates of the given OrganisationCertificateType for the given oranisation


/organisation/{OrganisationType}/{OrganisationId}/certificate/{OrganisationCertificateType}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/certificate/{OrganisationCertificateType}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OrganisationCertificatesApi;

import java.io.File;
import java.util.*;

public class OrganisationCertificatesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
        OAuth OAuth2SecurityReadOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadOps");
        OAuth2SecurityReadOps.setAccessToken("YOUR ACCESS TOKEN");

        OrganisationCertificatesApi apiInstance = new OrganisationCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String organisationCertificateType = organisationCertificateType_example; // String | The certificate type
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypeGet(organisationType, organisationId, organisationCertificateType, softwareStatementId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationCertificatesApi#organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypeGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OrganisationCertificatesApi;

public class OrganisationCertificatesApiExample {

    public static void main(String[] args) {
        OrganisationCertificatesApi apiInstance = new OrganisationCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String organisationCertificateType = organisationCertificateType_example; // String | The certificate type
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypeGet(organisationType, organisationId, organisationCertificateType, softwareStatementId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationCertificatesApi#organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypeGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *organisationCertificateType = organisationCertificateType_example; // The certificate type
String *softwareStatementId = softwareStatementId_example; // The software statement ID

OrganisationCertificatesApi *apiInstance = [[OrganisationCertificatesApi alloc] init];

// Get the certificates of the given OrganisationCertificateType for the given oranisation
[apiInstance organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypeGetWith:organisationType
    organisationId:organisationId
    organisationCertificateType:organisationCertificateType
    softwareStatementId:softwareStatementId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
var OAuth2SecurityReadOps = defaultClient.authentications['OAuth2SecurityReadOps'];
OAuth2SecurityReadOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OrganisationCertificatesApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var organisationCertificateType = organisationCertificateType_example; // {String} The certificate type

var softwareStatementId = softwareStatementId_example; // {String} The software statement ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypeGet(organisationType, organisationId, organisationCertificateType, softwareStatementId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypeGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrganisationCertificatesApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var organisationCertificateType = organisationCertificateType_example;  // String | The certificate type
            var softwareStatementId = softwareStatementId_example;  // String | The software statement ID

            try
            {
                // Get the certificates of the given OrganisationCertificateType for the given oranisation
                apiInstance.organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypeGet(organisationType, organisationId, organisationCertificateType, softwareStatementId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganisationCertificatesApi.organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OrganisationCertificatesApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$organisationCertificateType = organisationCertificateType_example; // String | The certificate type
$softwareStatementId = softwareStatementId_example; // String | The software statement ID

try {
    $api_instance->organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypeGet($organisationType, $organisationId, $organisationCertificateType, $softwareStatementId);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationCertificatesApi->organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypeGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganisationCertificatesApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OrganisationCertificatesApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $organisationCertificateType = organisationCertificateType_example; # String | The certificate type
my $softwareStatementId = softwareStatementId_example; # String | The software statement ID

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypeGet(organisationType => $organisationType, organisationId => $organisationId, organisationCertificateType => $organisationCertificateType, softwareStatementId => $softwareStatementId);
};
if ($@) {
    warn "Exception when calling OrganisationCertificatesApi->organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypeGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OrganisationCertificatesApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
organisationCertificateType = organisationCertificateType_example # String | The certificate type
softwareStatementId = softwareStatementId_example # String | The software statement ID

try: 
    # Get the certificates of the given OrganisationCertificateType for the given oranisation
    api_instance.organisation_organisation_type_organisation_id_certificate_organisation_certificate_type_get(organisationType, organisationId, organisationCertificateType, softwareStatementId)
except ApiException as e:
    print("Exception when calling OrganisationCertificatesApi->organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypeGet: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
OrganisationCertificateType*
String
The certificate type
Required
SoftwareStatementId*
String
The software statement ID
Required

Responses

Status: 200 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypePost

Store or create a new certificate of the given OrganisationCertificateType for the given organisation


/organisation/{OrganisationType}/{OrganisationId}/certificate/{OrganisationCertificateType}

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/certificate/{OrganisationCertificateType}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OrganisationCertificatesApi;

import java.io.File;
import java.util.*;

public class OrganisationCertificatesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
        OAuth OAuth2SecurityReadWriteOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadWriteOps");
        OAuth2SecurityReadWriteOps.setAccessToken("YOUR ACCESS TOKEN");

        OrganisationCertificatesApi apiInstance = new OrganisationCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String organisationCertificateType = organisationCertificateType_example; // String | The certificate type
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        CertificateOrKeyGetSchema certificateOrCSROrJWS = ; // CertificateOrKeyGetSchema | * __PEM file__ -- when the request `Content-Type` header is set to  `application/x-pem-file` the contents of the PEM file will differ depending upon `OrganisationCertificateType`. If `OrganisationCertificateType` is set to `qwac`, `qseal` then the PEM file should contain a *QWAC* or a *QSEAL* certificate respectively; if `OrganisationCertificateType` is set to `obwac` or `obseal` then the PEM file should contain a Certificate Signing Request (CSR) for an OB-issued *OBWAC* or *OBSEAL* certificate respectively.
* __Signed JWT__ -- when the request `Content-Type` header is set to `application/jwt` the body of the signed JWT will contain a CSR or a certificate.

### Requesting a Certificate using a signed JWT

The header `kid` claim is the ID of the QSealC certificate assigned to it by the OB JWKS store.

The body `csr` claim is the CSR in the DER format.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
}
{
  "csr": "string"
}
```

### Uploaing a Certificate using a signed JWT

The header `kid` claim is the ID of the QSealC certificate assigned to it by the OB JWKS store.

The body `x5c` claim is the array of certificate, issuer certificate, and root certificate in the DER format.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
}
{
  "x5c": ["qsealc", "issuer certificate", "root certificate"]
}
```

EXAMPLE REQUEST PAYLOAD USING SIGNED JWT REQUESTS

```
POST /organisation/tpp/123456789012345678/certificate/obwac HTTP/1.1
Content-Type: application/jwt
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmcibSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```

        try {
            apiInstance.organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypePost(organisationType, organisationId, organisationCertificateType, softwareStatementId, certificateOrCSROrJWS);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationCertificatesApi#organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypePost");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OrganisationCertificatesApi;

public class OrganisationCertificatesApiExample {

    public static void main(String[] args) {
        OrganisationCertificatesApi apiInstance = new OrganisationCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String organisationCertificateType = organisationCertificateType_example; // String | The certificate type
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        CertificateOrKeyGetSchema certificateOrCSROrJWS = ; // CertificateOrKeyGetSchema | * __PEM file__ -- when the request `Content-Type` header is set to  `application/x-pem-file` the contents of the PEM file will differ depending upon `OrganisationCertificateType`. If `OrganisationCertificateType` is set to `qwac`, `qseal` then the PEM file should contain a *QWAC* or a *QSEAL* certificate respectively; if `OrganisationCertificateType` is set to `obwac` or `obseal` then the PEM file should contain a Certificate Signing Request (CSR) for an OB-issued *OBWAC* or *OBSEAL* certificate respectively.
* __Signed JWT__ -- when the request `Content-Type` header is set to `application/jwt` the body of the signed JWT will contain a CSR or a certificate.

### Requesting a Certificate using a signed JWT

The header `kid` claim is the ID of the QSealC certificate assigned to it by the OB JWKS store.

The body `csr` claim is the CSR in the DER format.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
}
{
  "csr": "string"
}
```

### Uploaing a Certificate using a signed JWT

The header `kid` claim is the ID of the QSealC certificate assigned to it by the OB JWKS store.

The body `x5c` claim is the array of certificate, issuer certificate, and root certificate in the DER format.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
}
{
  "x5c": ["qsealc", "issuer certificate", "root certificate"]
}
```

EXAMPLE REQUEST PAYLOAD USING SIGNED JWT REQUESTS

```
POST /organisation/tpp/123456789012345678/certificate/obwac HTTP/1.1
Content-Type: application/jwt
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmcibSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```

        try {
            apiInstance.organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypePost(organisationType, organisationId, organisationCertificateType, softwareStatementId, certificateOrCSROrJWS);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationCertificatesApi#organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadWriteOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *organisationCertificateType = organisationCertificateType_example; // The certificate type
String *softwareStatementId = softwareStatementId_example; // The software statement ID
CertificateOrKeyGetSchema *certificateOrCSROrJWS = ; // * __PEM file__ -- when the request `Content-Type` header is set to  `application/x-pem-file` the contents of the PEM file will differ depending upon `OrganisationCertificateType`. If `OrganisationCertificateType` is set to `qwac`, `qseal` then the PEM file should contain a *QWAC* or a *QSEAL* certificate respectively; if `OrganisationCertificateType` is set to `obwac` or `obseal` then the PEM file should contain a Certificate Signing Request (CSR) for an OB-issued *OBWAC* or *OBSEAL* certificate respectively.
* __Signed JWT__ -- when the request `Content-Type` header is set to `application/jwt` the body of the signed JWT will contain a CSR or a certificate.

### Requesting a Certificate using a signed JWT

The header `kid` claim is the ID of the QSealC certificate assigned to it by the OB JWKS store.

The body `csr` claim is the CSR in the DER format.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
}
{
  "csr": "string"
}
```

### Uploaing a Certificate using a signed JWT

The header `kid` claim is the ID of the QSealC certificate assigned to it by the OB JWKS store.

The body `x5c` claim is the array of certificate, issuer certificate, and root certificate in the DER format.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
}
{
  "x5c": ["qsealc", "issuer certificate", "root certificate"]
}
```

EXAMPLE REQUEST PAYLOAD USING SIGNED JWT REQUESTS

```
POST /organisation/tpp/123456789012345678/certificate/obwac HTTP/1.1
Content-Type: application/jwt
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmcibSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```


OrganisationCertificatesApi *apiInstance = [[OrganisationCertificatesApi alloc] init];

// Store or create a new certificate of the given OrganisationCertificateType for the given organisation
[apiInstance organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypePostWith:organisationType
    organisationId:organisationId
    organisationCertificateType:organisationCertificateType
    softwareStatementId:softwareStatementId
    certificateOrCSROrJWS:certificateOrCSROrJWS
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
var OAuth2SecurityReadWriteOps = defaultClient.authentications['OAuth2SecurityReadWriteOps'];
OAuth2SecurityReadWriteOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OrganisationCertificatesApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var organisationCertificateType = organisationCertificateType_example; // {String} The certificate type

var softwareStatementId = softwareStatementId_example; // {String} The software statement ID

var certificateOrCSROrJWS = ; // {CertificateOrKeyGetSchema} * __PEM file__ -- when the request `Content-Type` header is set to  `application/x-pem-file` the contents of the PEM file will differ depending upon `OrganisationCertificateType`. If `OrganisationCertificateType` is set to `qwac`, `qseal` then the PEM file should contain a *QWAC* or a *QSEAL* certificate respectively; if `OrganisationCertificateType` is set to `obwac` or `obseal` then the PEM file should contain a Certificate Signing Request (CSR) for an OB-issued *OBWAC* or *OBSEAL* certificate respectively.
* __Signed JWT__ -- when the request `Content-Type` header is set to `application/jwt` the body of the signed JWT will contain a CSR or a certificate.

### Requesting a Certificate using a signed JWT

The header `kid` claim is the ID of the QSealC certificate assigned to it by the OB JWKS store.

The body `csr` claim is the CSR in the DER format.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
}
{
  "csr": "string"
}
```

### Uploaing a Certificate using a signed JWT

The header `kid` claim is the ID of the QSealC certificate assigned to it by the OB JWKS store.

The body `x5c` claim is the array of certificate, issuer certificate, and root certificate in the DER format.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
}
{
  "x5c": ["qsealc", "issuer certificate", "root certificate"]
}
```

EXAMPLE REQUEST PAYLOAD USING SIGNED JWT REQUESTS

```
POST /organisation/tpp/123456789012345678/certificate/obwac HTTP/1.1
Content-Type: application/jwt
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmcibSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```



var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypePost(organisationType, organisationId, organisationCertificateType, softwareStatementIdcertificateOrCSROrJWS, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypePostExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrganisationCertificatesApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var organisationCertificateType = organisationCertificateType_example;  // String | The certificate type
            var softwareStatementId = softwareStatementId_example;  // String | The software statement ID
            var certificateOrCSROrJWS = new CertificateOrKeyGetSchema(); // CertificateOrKeyGetSchema | * __PEM file__ -- when the request `Content-Type` header is set to  `application/x-pem-file` the contents of the PEM file will differ depending upon `OrganisationCertificateType`. If `OrganisationCertificateType` is set to `qwac`, `qseal` then the PEM file should contain a *QWAC* or a *QSEAL* certificate respectively; if `OrganisationCertificateType` is set to `obwac` or `obseal` then the PEM file should contain a Certificate Signing Request (CSR) for an OB-issued *OBWAC* or *OBSEAL* certificate respectively.
* __Signed JWT__ -- when the request `Content-Type` header is set to `application/jwt` the body of the signed JWT will contain a CSR or a certificate.

### Requesting a Certificate using a signed JWT

The header `kid` claim is the ID of the QSealC certificate assigned to it by the OB JWKS store.

The body `csr` claim is the CSR in the DER format.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
}
{
  "csr": "string"
}
```

### Uploaing a Certificate using a signed JWT

The header `kid` claim is the ID of the QSealC certificate assigned to it by the OB JWKS store.

The body `x5c` claim is the array of certificate, issuer certificate, and root certificate in the DER format.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
}
{
  "x5c": ["qsealc", "issuer certificate", "root certificate"]
}
```

EXAMPLE REQUEST PAYLOAD USING SIGNED JWT REQUESTS

```
POST /organisation/tpp/123456789012345678/certificate/obwac HTTP/1.1
Content-Type: application/jwt
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmcibSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```


            try
            {
                // Store or create a new certificate of the given OrganisationCertificateType for the given organisation
                apiInstance.organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypePost(organisationType, organisationId, organisationCertificateType, softwareStatementId, certificateOrCSROrJWS);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganisationCertificatesApi.organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OrganisationCertificatesApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$organisationCertificateType = organisationCertificateType_example; // String | The certificate type
$softwareStatementId = softwareStatementId_example; // String | The software statement ID
$certificateOrCSROrJWS = ; // CertificateOrKeyGetSchema | * __PEM file__ -- when the request `Content-Type` header is set to  `application/x-pem-file` the contents of the PEM file will differ depending upon `OrganisationCertificateType`. If `OrganisationCertificateType` is set to `qwac`, `qseal` then the PEM file should contain a *QWAC* or a *QSEAL* certificate respectively; if `OrganisationCertificateType` is set to `obwac` or `obseal` then the PEM file should contain a Certificate Signing Request (CSR) for an OB-issued *OBWAC* or *OBSEAL* certificate respectively.
* __Signed JWT__ -- when the request `Content-Type` header is set to `application/jwt` the body of the signed JWT will contain a CSR or a certificate.

### Requesting a Certificate using a signed JWT

The header `kid` claim is the ID of the QSealC certificate assigned to it by the OB JWKS store.

The body `csr` claim is the CSR in the DER format.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
}
{
  "csr": "string"
}
```

### Uploaing a Certificate using a signed JWT

The header `kid` claim is the ID of the QSealC certificate assigned to it by the OB JWKS store.

The body `x5c` claim is the array of certificate, issuer certificate, and root certificate in the DER format.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
}
{
  "x5c": ["qsealc", "issuer certificate", "root certificate"]
}
```

EXAMPLE REQUEST PAYLOAD USING SIGNED JWT REQUESTS

```
POST /organisation/tpp/123456789012345678/certificate/obwac HTTP/1.1
Content-Type: application/jwt
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmcibSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```


try {
    $api_instance->organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypePost($organisationType, $organisationId, $organisationCertificateType, $softwareStatementId, $certificateOrCSROrJWS);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationCertificatesApi->organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganisationCertificatesApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OrganisationCertificatesApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $organisationCertificateType = organisationCertificateType_example; # String | The certificate type
my $softwareStatementId = softwareStatementId_example; # String | The software statement ID
my $certificateOrCSROrJWS = WWW::SwaggerClient::Object::CertificateOrKeyGetSchema->new(); # CertificateOrKeyGetSchema | * __PEM file__ -- when the request `Content-Type` header is set to  `application/x-pem-file` the contents of the PEM file will differ depending upon `OrganisationCertificateType`. If `OrganisationCertificateType` is set to `qwac`, `qseal` then the PEM file should contain a *QWAC* or a *QSEAL* certificate respectively; if `OrganisationCertificateType` is set to `obwac` or `obseal` then the PEM file should contain a Certificate Signing Request (CSR) for an OB-issued *OBWAC* or *OBSEAL* certificate respectively.
* __Signed JWT__ -- when the request `Content-Type` header is set to `application/jwt` the body of the signed JWT will contain a CSR or a certificate.

### Requesting a Certificate using a signed JWT

The header `kid` claim is the ID of the QSealC certificate assigned to it by the OB JWKS store.

The body `csr` claim is the CSR in the DER format.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
}
{
  "csr": "string"
}
```

### Uploaing a Certificate using a signed JWT

The header `kid` claim is the ID of the QSealC certificate assigned to it by the OB JWKS store.

The body `x5c` claim is the array of certificate, issuer certificate, and root certificate in the DER format.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
}
{
  "x5c": ["qsealc", "issuer certificate", "root certificate"]
}
```

EXAMPLE REQUEST PAYLOAD USING SIGNED JWT REQUESTS

```
POST /organisation/tpp/123456789012345678/certificate/obwac HTTP/1.1
Content-Type: application/jwt
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmcibSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```


eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypePost(organisationType => $organisationType, organisationId => $organisationId, organisationCertificateType => $organisationCertificateType, softwareStatementId => $softwareStatementId, certificateOrCSROrJWS => $certificateOrCSROrJWS);
};
if ($@) {
    warn "Exception when calling OrganisationCertificatesApi->organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OrganisationCertificatesApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
organisationCertificateType = organisationCertificateType_example # String | The certificate type
softwareStatementId = softwareStatementId_example # String | The software statement ID
certificateOrCSROrJWS =  # CertificateOrKeyGetSchema | * __PEM file__ -- when the request `Content-Type` header is set to  `application/x-pem-file` the contents of the PEM file will differ depending upon `OrganisationCertificateType`. If `OrganisationCertificateType` is set to `qwac`, `qseal` then the PEM file should contain a *QWAC* or a *QSEAL* certificate respectively; if `OrganisationCertificateType` is set to `obwac` or `obseal` then the PEM file should contain a Certificate Signing Request (CSR) for an OB-issued *OBWAC* or *OBSEAL* certificate respectively.
* __Signed JWT__ -- when the request `Content-Type` header is set to `application/jwt` the body of the signed JWT will contain a CSR or a certificate.

### Requesting a Certificate using a signed JWT

The header `kid` claim is the ID of the QSealC certificate assigned to it by the OB JWKS store.

The body `csr` claim is the CSR in the DER format.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
}
{
  "csr": "string"
}
```

### Uploaing a Certificate using a signed JWT

The header `kid` claim is the ID of the QSealC certificate assigned to it by the OB JWKS store.

The body `x5c` claim is the array of certificate, issuer certificate, and root certificate in the DER format.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
}
{
  "x5c": ["qsealc", "issuer certificate", "root certificate"]
}
```

EXAMPLE REQUEST PAYLOAD USING SIGNED JWT REQUESTS

```
POST /organisation/tpp/123456789012345678/certificate/obwac HTTP/1.1
Content-Type: application/jwt
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmcibSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```


try: 
    # Store or create a new certificate of the given OrganisationCertificateType for the given organisation
    api_instance.organisation_organisation_type_organisation_id_certificate_organisation_certificate_type_post(organisationType, organisationId, organisationCertificateType, softwareStatementId, certificateOrCSROrJWS)
except ApiException as e:
    print("Exception when calling OrganisationCertificatesApi->organisationOrganisationTypeOrganisationIdCertificateOrganisationCertificateTypePost: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
OrganisationCertificateType*
String
The certificate type
Required
SoftwareStatementId*
String
The software statement ID
Required
Body parameters
Name Description
certificateOrCSROrJWS *

Responses

Status: 201 - Created

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Organisations

organisationOrganisationTypeGet

Get all organisations that the client is authorised to retrieve

Note that this was not in the original design but is included to inform the client


/organisation/{OrganisationType}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OrganisationsApi;

import java.io.File;
import java.util.*;

public class OrganisationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
        OAuth OAuth2SecurityReadOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadOps");
        OAuth2SecurityReadOps.setAccessToken("YOUR ACCESS TOKEN");

        OrganisationsApi apiInstance = new OrganisationsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        try {
            apiInstance.organisationOrganisationTypeGet(organisationType);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationsApi#organisationOrganisationTypeGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OrganisationsApi;

public class OrganisationsApiExample {

    public static void main(String[] args) {
        OrganisationsApi apiInstance = new OrganisationsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        try {
            apiInstance.organisationOrganisationTypeGet(organisationType);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationsApi#organisationOrganisationTypeGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type

OrganisationsApi *apiInstance = [[OrganisationsApi alloc] init];

// Get all organisations that the client is authorised to retrieve
[apiInstance organisationOrganisationTypeGetWith:organisationType
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
var OAuth2SecurityReadOps = defaultClient.authentications['OAuth2SecurityReadOps'];
OAuth2SecurityReadOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OrganisationsApi()

var organisationType = organisationType_example; // {String} OB Organisation Type


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeGet(organisationType, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrganisationsApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type

            try
            {
                // Get all organisations that the client is authorised to retrieve
                apiInstance.organisationOrganisationTypeGet(organisationType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganisationsApi.organisationOrganisationTypeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OrganisationsApi();
$organisationType = organisationType_example; // String | OB Organisation Type

try {
    $api_instance->organisationOrganisationTypeGet($organisationType);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationsApi->organisationOrganisationTypeGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganisationsApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OrganisationsApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type

eval { 
    $api_instance->organisationOrganisationTypeGet(organisationType => $organisationType);
};
if ($@) {
    warn "Exception when calling OrganisationsApi->organisationOrganisationTypeGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OrganisationsApi()
organisationType = organisationType_example # String | OB Organisation Type

try: 
    # Get all organisations that the client is authorised to retrieve
    api_instance.organisation_organisation_type_get(organisationType)
except ApiException as e:
    print("Exception when calling OrganisationsApi->organisationOrganisationTypeGet: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required

Responses

Status: 200 - List of the organisation - Schema in scim-swagger.json

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypeOrganisationIdGet

Get the given organisation's details


/organisation/{OrganisationType}/{OrganisationId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OrganisationsApi;

import java.io.File;
import java.util.*;

public class OrganisationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
        OAuth OAuth2SecurityReadOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadOps");
        OAuth2SecurityReadOps.setAccessToken("YOUR ACCESS TOKEN");

        OrganisationsApi apiInstance = new OrganisationsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdGet(organisationType, organisationId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationsApi#organisationOrganisationTypeOrganisationIdGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OrganisationsApi;

public class OrganisationsApiExample {

    public static void main(String[] args) {
        OrganisationsApi apiInstance = new OrganisationsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdGet(organisationType, organisationId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationsApi#organisationOrganisationTypeOrganisationIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID

OrganisationsApi *apiInstance = [[OrganisationsApi alloc] init];

// Get the given organisation's details
[apiInstance organisationOrganisationTypeOrganisationIdGetWith:organisationType
    organisationId:organisationId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
var OAuth2SecurityReadOps = defaultClient.authentications['OAuth2SecurityReadOps'];
OAuth2SecurityReadOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.OrganisationsApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdGet(organisationType, organisationId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrganisationsApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID

            try
            {
                // Get the given organisation's details
                apiInstance.organisationOrganisationTypeOrganisationIdGet(organisationType, organisationId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganisationsApi.organisationOrganisationTypeOrganisationIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OrganisationsApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID

try {
    $api_instance->organisationOrganisationTypeOrganisationIdGet($organisationType, $organisationId);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationsApi->organisationOrganisationTypeOrganisationIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganisationsApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OrganisationsApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdGet(organisationType => $organisationType, organisationId => $organisationId);
};
if ($@) {
    warn "Exception when calling OrganisationsApi->organisationOrganisationTypeOrganisationIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OrganisationsApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID

try: 
    # Get the given organisation's details
    api_instance.organisation_organisation_type_organisation_id_get(organisationType, organisationId)
except ApiException as e:
    print("Exception when calling OrganisationsApi->organisationOrganisationTypeOrganisationIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required

Responses

Status: 200 - Full details of the organisation - Schema in scim-swagger.json

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypePost

Enrol a eIDAS QWAC/QSealC-bearing participant

Enrol an eIDAS QWAC/QSealC certificate-bearing participant onto the Open Banking Directory. Currenty only TPPs can use this enrolment endpoint, so please set `OrganisationType` to `tpp`


/organisation/{OrganisationType}

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OrganisationsApi;

import java.io.File;
import java.util.*;

public class OrganisationsApiExample {

    public static void main(String[] args) {
        
        OrganisationsApi apiInstance = new OrganisationsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationTypeForQSealCOnboarding = organisationTypeForQSealCOnboarding_example; // String | OB Organisation Type
        EnrolSchema enrol = ; // EnrolSchema | The payload submitted when a TPP attempts to enrol with an eIDAS QWAC or QSealC certificate. It's format and contents will depend on the value of the `Content-Type` header:  TPP onto the Open Banking Directory (required fields to be validated). For eIDAS QSealC-bearing TPPs use a signed JWT (JWS).

* __application/json__ -- a JSON payload for QWAC onboarding.
* __application/jwt__ -- a signed JWT (JWS) for QSealC onboarding.
* __application/jose__ -- same as __application/jwt__.

## QWAC-based Onboarding

Set `Content-Type` to `application/json` and send the payload conforming to the schema.

EXAMPLE REQUEST PAYLOAD FOR QWAC-BASED ONBOARDING

```
POST /organisation/tpp HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
{
  "client_name": "string",
  "scope": "string",
  "token_endpoint_auth_method": "string",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "token_endpoint_auth_signing_alg": "string"
}
```

## QSealC-based Onboarding

Set `Content-Type` to `application/jwt` or `application/jose` and send the payload conforming to the schema as a signed JWT.

The QSealC, the issuing certificate, and the root certificate (all in DER format) must be used as the items of the array, which forms the value of the `x5c` claim in the JWT header.

The JWT MUST be signed using the private key associated with the QSealC listed in the `x5c` claim in the header.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
  "x5c": ["qsealc", "issuer certificate", "root certificate"]
}
{
  "client_name": "string",
  "scope": "string",
  "token_endpoint_auth_method": "string",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "token_endpoint_auth_signing_alg": "string"
}
```

EXAMPLE REQUEST PAYLOAD FOR QSealC-BASED ONBOARDING

```
POST /organisation/tpp HTTP/1.1
Content-Type: application/jwt | application/jose
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmciXSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```

        try {
            apiInstance.organisationOrganisationTypePost(organisationType, organisationTypeForQSealCOnboarding, enrol);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationsApi#organisationOrganisationTypePost");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.OrganisationsApi;

public class OrganisationsApiExample {

    public static void main(String[] args) {
        OrganisationsApi apiInstance = new OrganisationsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationTypeForQSealCOnboarding = organisationTypeForQSealCOnboarding_example; // String | OB Organisation Type
        EnrolSchema enrol = ; // EnrolSchema | The payload submitted when a TPP attempts to enrol with an eIDAS QWAC or QSealC certificate. It's format and contents will depend on the value of the `Content-Type` header:  TPP onto the Open Banking Directory (required fields to be validated). For eIDAS QSealC-bearing TPPs use a signed JWT (JWS).

* __application/json__ -- a JSON payload for QWAC onboarding.
* __application/jwt__ -- a signed JWT (JWS) for QSealC onboarding.
* __application/jose__ -- same as __application/jwt__.

## QWAC-based Onboarding

Set `Content-Type` to `application/json` and send the payload conforming to the schema.

EXAMPLE REQUEST PAYLOAD FOR QWAC-BASED ONBOARDING

```
POST /organisation/tpp HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
{
  "client_name": "string",
  "scope": "string",
  "token_endpoint_auth_method": "string",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "token_endpoint_auth_signing_alg": "string"
}
```

## QSealC-based Onboarding

Set `Content-Type` to `application/jwt` or `application/jose` and send the payload conforming to the schema as a signed JWT.

The QSealC, the issuing certificate, and the root certificate (all in DER format) must be used as the items of the array, which forms the value of the `x5c` claim in the JWT header.

The JWT MUST be signed using the private key associated with the QSealC listed in the `x5c` claim in the header.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
  "x5c": ["qsealc", "issuer certificate", "root certificate"]
}
{
  "client_name": "string",
  "scope": "string",
  "token_endpoint_auth_method": "string",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "token_endpoint_auth_signing_alg": "string"
}
```

EXAMPLE REQUEST PAYLOAD FOR QSealC-BASED ONBOARDING

```
POST /organisation/tpp HTTP/1.1
Content-Type: application/jwt | application/jose
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmciXSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```

        try {
            apiInstance.organisationOrganisationTypePost(organisationType, organisationTypeForQSealCOnboarding, enrol);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationsApi#organisationOrganisationTypePost");
            e.printStackTrace();
        }
    }
}
String *organisationType = organisationType_example; // OB Organisation Type
String *organisationTypeForQSealCOnboarding = organisationTypeForQSealCOnboarding_example; // OB Organisation Type
EnrolSchema *enrol = ; // The payload submitted when a TPP attempts to enrol with an eIDAS QWAC or QSealC certificate. It's format and contents will depend on the value of the `Content-Type` header:  TPP onto the Open Banking Directory (required fields to be validated). For eIDAS QSealC-bearing TPPs use a signed JWT (JWS).

* __application/json__ -- a JSON payload for QWAC onboarding.
* __application/jwt__ -- a signed JWT (JWS) for QSealC onboarding.
* __application/jose__ -- same as __application/jwt__.

## QWAC-based Onboarding

Set `Content-Type` to `application/json` and send the payload conforming to the schema.

EXAMPLE REQUEST PAYLOAD FOR QWAC-BASED ONBOARDING

```
POST /organisation/tpp HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
{
  "client_name": "string",
  "scope": "string",
  "token_endpoint_auth_method": "string",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "token_endpoint_auth_signing_alg": "string"
}
```

## QSealC-based Onboarding

Set `Content-Type` to `application/jwt` or `application/jose` and send the payload conforming to the schema as a signed JWT.

The QSealC, the issuing certificate, and the root certificate (all in DER format) must be used as the items of the array, which forms the value of the `x5c` claim in the JWT header.

The JWT MUST be signed using the private key associated with the QSealC listed in the `x5c` claim in the header.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
  "x5c": ["qsealc", "issuer certificate", "root certificate"]
}
{
  "client_name": "string",
  "scope": "string",
  "token_endpoint_auth_method": "string",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "token_endpoint_auth_signing_alg": "string"
}
```

EXAMPLE REQUEST PAYLOAD FOR QSealC-BASED ONBOARDING

```
POST /organisation/tpp HTTP/1.1
Content-Type: application/jwt | application/jose
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmciXSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```


OrganisationsApi *apiInstance = [[OrganisationsApi alloc] init];

// Enrol a eIDAS QWAC/QSealC-bearing participant
[apiInstance organisationOrganisationTypePostWith:organisationType
    organisationTypeForQSealCOnboarding:organisationTypeForQSealCOnboarding
    enrol:enrol
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');

var api = new OpenBankingApi.OrganisationsApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationTypeForQSealCOnboarding = organisationTypeForQSealCOnboarding_example; // {String} OB Organisation Type

var enrol = ; // {EnrolSchema} The payload submitted when a TPP attempts to enrol with an eIDAS QWAC or QSealC certificate. It's format and contents will depend on the value of the `Content-Type` header:  TPP onto the Open Banking Directory (required fields to be validated). For eIDAS QSealC-bearing TPPs use a signed JWT (JWS).

* __application/json__ -- a JSON payload for QWAC onboarding.
* __application/jwt__ -- a signed JWT (JWS) for QSealC onboarding.
* __application/jose__ -- same as __application/jwt__.

## QWAC-based Onboarding

Set `Content-Type` to `application/json` and send the payload conforming to the schema.

EXAMPLE REQUEST PAYLOAD FOR QWAC-BASED ONBOARDING

```
POST /organisation/tpp HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
{
  "client_name": "string",
  "scope": "string",
  "token_endpoint_auth_method": "string",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "token_endpoint_auth_signing_alg": "string"
}
```

## QSealC-based Onboarding

Set `Content-Type` to `application/jwt` or `application/jose` and send the payload conforming to the schema as a signed JWT.

The QSealC, the issuing certificate, and the root certificate (all in DER format) must be used as the items of the array, which forms the value of the `x5c` claim in the JWT header.

The JWT MUST be signed using the private key associated with the QSealC listed in the `x5c` claim in the header.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
  "x5c": ["qsealc", "issuer certificate", "root certificate"]
}
{
  "client_name": "string",
  "scope": "string",
  "token_endpoint_auth_method": "string",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "token_endpoint_auth_signing_alg": "string"
}
```

EXAMPLE REQUEST PAYLOAD FOR QSealC-BASED ONBOARDING

```
POST /organisation/tpp HTTP/1.1
Content-Type: application/jwt | application/jose
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmciXSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```



var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypePost(organisationType, organisationTypeForQSealCOnboarding, enrol, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypePostExample
    {
        public void main()
        {
            
            var apiInstance = new OrganisationsApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationTypeForQSealCOnboarding = organisationTypeForQSealCOnboarding_example;  // String | OB Organisation Type
            var enrol = new EnrolSchema(); // EnrolSchema | The payload submitted when a TPP attempts to enrol with an eIDAS QWAC or QSealC certificate. It's format and contents will depend on the value of the `Content-Type` header:  TPP onto the Open Banking Directory (required fields to be validated). For eIDAS QSealC-bearing TPPs use a signed JWT (JWS).

* __application/json__ -- a JSON payload for QWAC onboarding.
* __application/jwt__ -- a signed JWT (JWS) for QSealC onboarding.
* __application/jose__ -- same as __application/jwt__.

## QWAC-based Onboarding

Set `Content-Type` to `application/json` and send the payload conforming to the schema.

EXAMPLE REQUEST PAYLOAD FOR QWAC-BASED ONBOARDING

```
POST /organisation/tpp HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
{
  "client_name": "string",
  "scope": "string",
  "token_endpoint_auth_method": "string",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "token_endpoint_auth_signing_alg": "string"
}
```

## QSealC-based Onboarding

Set `Content-Type` to `application/jwt` or `application/jose` and send the payload conforming to the schema as a signed JWT.

The QSealC, the issuing certificate, and the root certificate (all in DER format) must be used as the items of the array, which forms the value of the `x5c` claim in the JWT header.

The JWT MUST be signed using the private key associated with the QSealC listed in the `x5c` claim in the header.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
  "x5c": ["qsealc", "issuer certificate", "root certificate"]
}
{
  "client_name": "string",
  "scope": "string",
  "token_endpoint_auth_method": "string",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "token_endpoint_auth_signing_alg": "string"
}
```

EXAMPLE REQUEST PAYLOAD FOR QSealC-BASED ONBOARDING

```
POST /organisation/tpp HTTP/1.1
Content-Type: application/jwt | application/jose
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmciXSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```


            try
            {
                // Enrol a eIDAS QWAC/QSealC-bearing participant
                apiInstance.organisationOrganisationTypePost(organisationType, organisationTypeForQSealCOnboarding, enrol);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganisationsApi.organisationOrganisationTypePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\OrganisationsApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationTypeForQSealCOnboarding = organisationTypeForQSealCOnboarding_example; // String | OB Organisation Type
$enrol = ; // EnrolSchema | The payload submitted when a TPP attempts to enrol with an eIDAS QWAC or QSealC certificate. It's format and contents will depend on the value of the `Content-Type` header:  TPP onto the Open Banking Directory (required fields to be validated). For eIDAS QSealC-bearing TPPs use a signed JWT (JWS).

* __application/json__ -- a JSON payload for QWAC onboarding.
* __application/jwt__ -- a signed JWT (JWS) for QSealC onboarding.
* __application/jose__ -- same as __application/jwt__.

## QWAC-based Onboarding

Set `Content-Type` to `application/json` and send the payload conforming to the schema.

EXAMPLE REQUEST PAYLOAD FOR QWAC-BASED ONBOARDING

```
POST /organisation/tpp HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
{
  "client_name": "string",
  "scope": "string",
  "token_endpoint_auth_method": "string",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "token_endpoint_auth_signing_alg": "string"
}
```

## QSealC-based Onboarding

Set `Content-Type` to `application/jwt` or `application/jose` and send the payload conforming to the schema as a signed JWT.

The QSealC, the issuing certificate, and the root certificate (all in DER format) must be used as the items of the array, which forms the value of the `x5c` claim in the JWT header.

The JWT MUST be signed using the private key associated with the QSealC listed in the `x5c` claim in the header.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
  "x5c": ["qsealc", "issuer certificate", "root certificate"]
}
{
  "client_name": "string",
  "scope": "string",
  "token_endpoint_auth_method": "string",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "token_endpoint_auth_signing_alg": "string"
}
```

EXAMPLE REQUEST PAYLOAD FOR QSealC-BASED ONBOARDING

```
POST /organisation/tpp HTTP/1.1
Content-Type: application/jwt | application/jose
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmciXSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```


try {
    $api_instance->organisationOrganisationTypePost($organisationType, $organisationTypeForQSealCOnboarding, $enrol);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationsApi->organisationOrganisationTypePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganisationsApi;

my $api_instance = WWW::SwaggerClient::OrganisationsApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationTypeForQSealCOnboarding = organisationTypeForQSealCOnboarding_example; # String | OB Organisation Type
my $enrol = WWW::SwaggerClient::Object::EnrolSchema->new(); # EnrolSchema | The payload submitted when a TPP attempts to enrol with an eIDAS QWAC or QSealC certificate. It's format and contents will depend on the value of the `Content-Type` header:  TPP onto the Open Banking Directory (required fields to be validated). For eIDAS QSealC-bearing TPPs use a signed JWT (JWS).

* __application/json__ -- a JSON payload for QWAC onboarding.
* __application/jwt__ -- a signed JWT (JWS) for QSealC onboarding.
* __application/jose__ -- same as __application/jwt__.

## QWAC-based Onboarding

Set `Content-Type` to `application/json` and send the payload conforming to the schema.

EXAMPLE REQUEST PAYLOAD FOR QWAC-BASED ONBOARDING

```
POST /organisation/tpp HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
{
  "client_name": "string",
  "scope": "string",
  "token_endpoint_auth_method": "string",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "token_endpoint_auth_signing_alg": "string"
}
```

## QSealC-based Onboarding

Set `Content-Type` to `application/jwt` or `application/jose` and send the payload conforming to the schema as a signed JWT.

The QSealC, the issuing certificate, and the root certificate (all in DER format) must be used as the items of the array, which forms the value of the `x5c` claim in the JWT header.

The JWT MUST be signed using the private key associated with the QSealC listed in the `x5c` claim in the header.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
  "x5c": ["qsealc", "issuer certificate", "root certificate"]
}
{
  "client_name": "string",
  "scope": "string",
  "token_endpoint_auth_method": "string",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "token_endpoint_auth_signing_alg": "string"
}
```

EXAMPLE REQUEST PAYLOAD FOR QSealC-BASED ONBOARDING

```
POST /organisation/tpp HTTP/1.1
Content-Type: application/jwt | application/jose
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmciXSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```


eval { 
    $api_instance->organisationOrganisationTypePost(organisationType => $organisationType, organisationTypeForQSealCOnboarding => $organisationTypeForQSealCOnboarding, enrol => $enrol);
};
if ($@) {
    warn "Exception when calling OrganisationsApi->organisationOrganisationTypePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.OrganisationsApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationTypeForQSealCOnboarding = organisationTypeForQSealCOnboarding_example # String | OB Organisation Type
enrol =  # EnrolSchema | The payload submitted when a TPP attempts to enrol with an eIDAS QWAC or QSealC certificate. It's format and contents will depend on the value of the `Content-Type` header:  TPP onto the Open Banking Directory (required fields to be validated). For eIDAS QSealC-bearing TPPs use a signed JWT (JWS).

* __application/json__ -- a JSON payload for QWAC onboarding.
* __application/jwt__ -- a signed JWT (JWS) for QSealC onboarding.
* __application/jose__ -- same as __application/jwt__.

## QWAC-based Onboarding

Set `Content-Type` to `application/json` and send the payload conforming to the schema.

EXAMPLE REQUEST PAYLOAD FOR QWAC-BASED ONBOARDING

```
POST /organisation/tpp HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
{
  "client_name": "string",
  "scope": "string",
  "token_endpoint_auth_method": "string",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "token_endpoint_auth_signing_alg": "string"
}
```

## QSealC-based Onboarding

Set `Content-Type` to `application/jwt` or `application/jose` and send the payload conforming to the schema as a signed JWT.

The QSealC, the issuing certificate, and the root certificate (all in DER format) must be used as the items of the array, which forms the value of the `x5c` claim in the JWT header.

The JWT MUST be signed using the private key associated with the QSealC listed in the `x5c` claim in the header.

```
{
  "typ": "JWT",
  "alg": "ES256",
  "kid": "ABCD1234",
  "x5c": ["qsealc", "issuer certificate", "root certificate"]
}
{
  "client_name": "string",
  "scope": "string",
  "token_endpoint_auth_method": "string",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "token_endpoint_auth_signing_alg": "string"
}
```

EXAMPLE REQUEST PAYLOAD FOR QSealC-BASED ONBOARDING

```
POST /organisation/tpp HTTP/1.1
Content-Type: application/jwt | application/jose
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmciXSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```


try: 
    # Enrol a eIDAS QWAC/QSealC-bearing participant
    api_instance.organisation_organisation_type_post(organisationType, organisationTypeForQSealCOnboarding, enrol)
except ApiException as e:
    print("Exception when calling OrganisationsApi->organisationOrganisationTypePost: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationTypeForQSealCOnboarding*
String
OB Organisation Type
Required
Body parameters
Name Description
enrol *

Responses

Status: 201 - Created

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

PCA

personalCurrentAccountsGet

Gets a list of all `Personal Current Account` objects.


/personal-current-accounts

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/personal-current-accounts"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.PCAApi;

import java.io.File;
import java.util.*;

public class PCAApiExample {

    public static void main(String[] args) {
        
        PCAApi apiInstance = new PCAApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            PersonalCurrentAccountResponse result = apiInstance.personalCurrentAccountsGet(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PCAApi#personalCurrentAccountsGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.PCAApi;

public class PCAApiExample {

    public static void main(String[] args) {
        PCAApi apiInstance = new PCAApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            PersonalCurrentAccountResponse result = apiInstance.personalCurrentAccountsGet(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PCAApi#personalCurrentAccountsGet");
            e.printStackTrace();
        }
    }
}
String *ifModifiedSince = ifModifiedSince_example; // Used for conditional request, to retrieve data only if modified since a given date (optional)
String *ifNoneMatch = ifNoneMatch_example; // Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

PCAApi *apiInstance = [[PCAApi alloc] init];

[apiInstance personalCurrentAccountsGetWith:ifModifiedSince
    ifNoneMatch:ifNoneMatch
              completionHandler: ^(PersonalCurrentAccountResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');

var api = new OpenBankingApi.PCAApi()

var opts = { 
  'ifModifiedSince': ifModifiedSince_example, // {String} Used for conditional request, to retrieve data only if modified since a given date
  'ifNoneMatch': ifNoneMatch_example // {String} Used for conditional request, to retrieve data only if the given Etag value does not match
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.personalCurrentAccountsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class personalCurrentAccountsGetExample
    {
        public void main()
        {
            
            var apiInstance = new PCAApi();
            var ifModifiedSince = ifModifiedSince_example;  // String | Used for conditional request, to retrieve data only if modified since a given date (optional) 
            var ifNoneMatch = ifNoneMatch_example;  // String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional) 

            try
            {
                PersonalCurrentAccountResponse result = apiInstance.personalCurrentAccountsGet(ifModifiedSince, ifNoneMatch);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PCAApi.personalCurrentAccountsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\PCAApi();
$ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
$ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match

try {
    $result = $api_instance->personalCurrentAccountsGet($ifModifiedSince, $ifNoneMatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PCAApi->personalCurrentAccountsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PCAApi;

my $api_instance = WWW::SwaggerClient::PCAApi->new();
my $ifModifiedSince = ifModifiedSince_example; # String | Used for conditional request, to retrieve data only if modified since a given date
my $ifNoneMatch = ifNoneMatch_example; # String | Used for conditional request, to retrieve data only if the given Etag value does not match

eval { 
    my $result = $api_instance->personalCurrentAccountsGet(ifModifiedSince => $ifModifiedSince, ifNoneMatch => $ifNoneMatch);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PCAApi->personalCurrentAccountsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PCAApi()
ifModifiedSince = ifModifiedSince_example # String | Used for conditional request, to retrieve data only if modified since a given date (optional)
ifNoneMatch = ifNoneMatch_example # String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

try: 
    api_response = api_instance.personal_current_accounts_get(ifModifiedSince=ifModifiedSince, ifNoneMatch=ifNoneMatch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PCAApi->personalCurrentAccountsGet: %s\n" % e)

Parameters

Header parameters
Name Description
If-Modified-Since
String
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
String
Used for conditional request, to retrieve data only if the given Etag value does not match

Responses

Status: 200 - Successful response with a list of `Personal Current Account` data

Name Type Format Description
Cache-Control String Describes how long this response can be cached
Etag String A unique ID identifying whether this resource has changed
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 400 - You have sent a request which could not be understood.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 408 - Your client has failed to submit a request, and a timeout has occurred.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 429 - You have requested this resource too often. Slow down.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 500 - An error occurred on the server. No further information is available.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 503 - The service is temporarily unavailable.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: default - A standard error response.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

personalCurrentAccountsHead

Gets header information on the current set of `Personal Current Account` data


/personal-current-accounts

Usage and SDK Samples

curl -X HEAD "https://localhost:8080/open-banking/v2.3/personal-current-accounts"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.PCAApi;

import java.io.File;
import java.util.*;

public class PCAApiExample {

    public static void main(String[] args) {
        
        PCAApi apiInstance = new PCAApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            Object result = apiInstance.personalCurrentAccountsHead(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PCAApi#personalCurrentAccountsHead");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.PCAApi;

public class PCAApiExample {

    public static void main(String[] args) {
        PCAApi apiInstance = new PCAApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            Object result = apiInstance.personalCurrentAccountsHead(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PCAApi#personalCurrentAccountsHead");
            e.printStackTrace();
        }
    }
}
String *ifModifiedSince = ifModifiedSince_example; // Used for conditional request, to retrieve data only if modified since a given date (optional)
String *ifNoneMatch = ifNoneMatch_example; // Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

PCAApi *apiInstance = [[PCAApi alloc] init];

[apiInstance personalCurrentAccountsHeadWith:ifModifiedSince
    ifNoneMatch:ifNoneMatch
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');

var api = new OpenBankingApi.PCAApi()

var opts = { 
  'ifModifiedSince': ifModifiedSince_example, // {String} Used for conditional request, to retrieve data only if modified since a given date
  'ifNoneMatch': ifNoneMatch_example // {String} Used for conditional request, to retrieve data only if the given Etag value does not match
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.personalCurrentAccountsHead(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class personalCurrentAccountsHeadExample
    {
        public void main()
        {
            
            var apiInstance = new PCAApi();
            var ifModifiedSince = ifModifiedSince_example;  // String | Used for conditional request, to retrieve data only if modified since a given date (optional) 
            var ifNoneMatch = ifNoneMatch_example;  // String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional) 

            try
            {
                Object result = apiInstance.personalCurrentAccountsHead(ifModifiedSince, ifNoneMatch);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PCAApi.personalCurrentAccountsHead: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\PCAApi();
$ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
$ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match

try {
    $result = $api_instance->personalCurrentAccountsHead($ifModifiedSince, $ifNoneMatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PCAApi->personalCurrentAccountsHead: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PCAApi;

my $api_instance = WWW::SwaggerClient::PCAApi->new();
my $ifModifiedSince = ifModifiedSince_example; # String | Used for conditional request, to retrieve data only if modified since a given date
my $ifNoneMatch = ifNoneMatch_example; # String | Used for conditional request, to retrieve data only if the given Etag value does not match

eval { 
    my $result = $api_instance->personalCurrentAccountsHead(ifModifiedSince => $ifModifiedSince, ifNoneMatch => $ifNoneMatch);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PCAApi->personalCurrentAccountsHead: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PCAApi()
ifModifiedSince = ifModifiedSince_example # String | Used for conditional request, to retrieve data only if modified since a given date (optional)
ifNoneMatch = ifNoneMatch_example # String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

try: 
    api_response = api_instance.personal_current_accounts_head(ifModifiedSince=ifModifiedSince, ifNoneMatch=ifNoneMatch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PCAApi->personalCurrentAccountsHead: %s\n" % e)

Parameters

Header parameters
Name Description
If-Modified-Since
String
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
String
Used for conditional request, to retrieve data only if the given Etag value does not match

Responses

Status: default - No response


Parties

getAccountsAccountIdParties

Get Parties


/accounts/{AccountId}/parties

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/accounts/{AccountId}/parties"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.PartiesApi;

import java.io.File;
import java.util.*;

public class PartiesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        PartiesApi apiInstance = new PartiesApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadParty3 result = apiInstance.getAccountsAccountIdParties(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartiesApi#getAccountsAccountIdParties");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.PartiesApi;

public class PartiesApiExample {

    public static void main(String[] args) {
        PartiesApi apiInstance = new PartiesApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadParty3 result = apiInstance.getAccountsAccountIdParties(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartiesApi#getAccountsAccountIdParties");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

PartiesApi *apiInstance = [[PartiesApi alloc] init];

// Get Parties
[apiInstance getAccountsAccountIdPartiesWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadParty3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.PartiesApi()

var accountId = accountId_example; // {String} AccountId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdParties(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdPartiesExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PartiesApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Parties
                OBReadParty3 result = apiInstance.getAccountsAccountIdParties(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PartiesApi.getAccountsAccountIdParties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\PartiesApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getAccountsAccountIdParties($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PartiesApi->getAccountsAccountIdParties: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PartiesApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PartiesApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getAccountsAccountIdParties(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PartiesApi->getAccountsAccountIdParties: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PartiesApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Parties
    api_response = api_instance.get_accounts_account_id_parties(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PartiesApi->getAccountsAccountIdParties: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Parties Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getAccountsAccountIdParty

Get Parties


/accounts/{AccountId}/party

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/accounts/{AccountId}/party"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.PartiesApi;

import java.io.File;
import java.util.*;

public class PartiesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        PartiesApi apiInstance = new PartiesApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadParty2 result = apiInstance.getAccountsAccountIdParty(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartiesApi#getAccountsAccountIdParty");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.PartiesApi;

public class PartiesApiExample {

    public static void main(String[] args) {
        PartiesApi apiInstance = new PartiesApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadParty2 result = apiInstance.getAccountsAccountIdParty(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartiesApi#getAccountsAccountIdParty");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

PartiesApi *apiInstance = [[PartiesApi alloc] init];

// Get Parties
[apiInstance getAccountsAccountIdPartyWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadParty2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.PartiesApi()

var accountId = accountId_example; // {String} AccountId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdParty(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdPartyExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PartiesApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Parties
                OBReadParty2 result = apiInstance.getAccountsAccountIdParty(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PartiesApi.getAccountsAccountIdParty: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\PartiesApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getAccountsAccountIdParty($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PartiesApi->getAccountsAccountIdParty: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PartiesApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PartiesApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getAccountsAccountIdParty(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PartiesApi->getAccountsAccountIdParty: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PartiesApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Parties
    api_response = api_instance.get_accounts_account_id_party(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PartiesApi->getAccountsAccountIdParty: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Parties Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getParty

Get Parties


/party

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/party"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.PartiesApi;

import java.io.File;
import java.util.*;

public class PartiesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        PartiesApi apiInstance = new PartiesApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadParty2 result = apiInstance.getParty(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartiesApi#getParty");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.PartiesApi;

public class PartiesApiExample {

    public static void main(String[] args) {
        PartiesApi apiInstance = new PartiesApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadParty2 result = apiInstance.getParty(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartiesApi#getParty");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

PartiesApi *apiInstance = [[PartiesApi alloc] init];

// Get Parties
[apiInstance getPartyWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadParty2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.PartiesApi()

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getParty(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPartyExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PartiesApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Parties
                OBReadParty2 result = apiInstance.getParty(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PartiesApi.getParty: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\PartiesApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getParty($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PartiesApi->getParty: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PartiesApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PartiesApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getParty(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PartiesApi->getParty: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PartiesApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Parties
    api_response = api_instance.get_party(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PartiesApi->getParty: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Parties Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

PaymentDetails

getDomesticPaymentsDomesticPaymentIdPaymentDetails

Get Payment Details


/domestic-payments/{DomesticPaymentId}/payment-details

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/domestic-payments/{DomesticPaymentId}/payment-details"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticPaymentsDomesticPaymentIdPaymentDetails(domesticPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getDomesticPaymentsDomesticPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticPaymentsDomesticPaymentIdPaymentDetails(domesticPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getDomesticPaymentsDomesticPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *domesticPaymentId = domesticPaymentId_example; // DomesticPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Get Payment Details
[apiInstance getDomesticPaymentsDomesticPaymentIdPaymentDetailsWith:domesticPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWritePaymentDetailsResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.PaymentDetailsApi()

var domesticPaymentId = domesticPaymentId_example; // {String} DomesticPaymentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticPaymentsDomesticPaymentIdPaymentDetails(domesticPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticPaymentsDomesticPaymentIdPaymentDetailsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var domesticPaymentId = domesticPaymentId_example;  // String | DomesticPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Payment Details
                OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticPaymentsDomesticPaymentIdPaymentDetails(domesticPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.getDomesticPaymentsDomesticPaymentIdPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\PaymentDetailsApi();
$domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getDomesticPaymentsDomesticPaymentIdPaymentDetails($domesticPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getDomesticPaymentsDomesticPaymentIdPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $domesticPaymentId = domesticPaymentId_example; # String | DomesticPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getDomesticPaymentsDomesticPaymentIdPaymentDetails(domesticPaymentId => $domesticPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->getDomesticPaymentsDomesticPaymentIdPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
domesticPaymentId = domesticPaymentId_example # String | DomesticPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Payment Details
    api_response = api_instance.get_domestic_payments_domestic_payment_id_payment_details(domesticPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->getDomesticPaymentsDomesticPaymentIdPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
DomesticPaymentId*
String
DomesticPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Payment Details Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails

Get Payment Details


/domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails(domesticScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails(domesticScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *domesticScheduledPaymentId = domesticScheduledPaymentId_example; // DomesticScheduledPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Get Payment Details
[apiInstance getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetailsWith:domesticScheduledPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWritePaymentDetailsResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.PaymentDetailsApi()

var domesticScheduledPaymentId = domesticScheduledPaymentId_example; // {String} DomesticScheduledPaymentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails(domesticScheduledPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetailsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var domesticScheduledPaymentId = domesticScheduledPaymentId_example;  // String | DomesticScheduledPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Payment Details
                OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails(domesticScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\PaymentDetailsApi();
$domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails($domesticScheduledPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $domesticScheduledPaymentId = domesticScheduledPaymentId_example; # String | DomesticScheduledPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails(domesticScheduledPaymentId => $domesticScheduledPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
domesticScheduledPaymentId = domesticScheduledPaymentId_example # String | DomesticScheduledPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Payment Details
    api_response = api_instance.get_domestic_scheduled_payments_domestic_scheduled_payment_id_payment_details(domesticScheduledPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
DomesticScheduledPaymentId*
String
DomesticScheduledPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Payment Details Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails

Get Payment Details


/domestic-standing-orders/{DomesticStandingOrderId}/payment-details

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/domestic-standing-orders/{DomesticStandingOrderId}/payment-details"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String domesticStandingOrderId = domesticStandingOrderId_example; // String | DomesticStandingOrderId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails(domesticStandingOrderId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String domesticStandingOrderId = domesticStandingOrderId_example; // String | DomesticStandingOrderId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails(domesticStandingOrderId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *domesticStandingOrderId = domesticStandingOrderId_example; // DomesticStandingOrderId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Get Payment Details
[apiInstance getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetailsWith:domesticStandingOrderId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWritePaymentDetailsResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.PaymentDetailsApi()

var domesticStandingOrderId = domesticStandingOrderId_example; // {String} DomesticStandingOrderId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails(domesticStandingOrderId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetailsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var domesticStandingOrderId = domesticStandingOrderId_example;  // String | DomesticStandingOrderId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Payment Details
                OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails(domesticStandingOrderId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\PaymentDetailsApi();
$domesticStandingOrderId = domesticStandingOrderId_example; // String | DomesticStandingOrderId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails($domesticStandingOrderId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $domesticStandingOrderId = domesticStandingOrderId_example; # String | DomesticStandingOrderId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails(domesticStandingOrderId => $domesticStandingOrderId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
domesticStandingOrderId = domesticStandingOrderId_example # String | DomesticStandingOrderId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Payment Details
    api_response = api_instance.get_domestic_standing_orders_domestic_standing_order_id_payment_details(domesticStandingOrderId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
DomesticStandingOrderId*
String
DomesticStandingOrderId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Payment Details Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getFilePaymentsFilePaymentIdPaymentDetails

Get Payment Details


/file-payments/{FilePaymentId}/payment-details

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/file-payments/{FilePaymentId}/payment-details"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String filePaymentId = filePaymentId_example; // String | FilePaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getFilePaymentsFilePaymentIdPaymentDetails(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getFilePaymentsFilePaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String filePaymentId = filePaymentId_example; // String | FilePaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getFilePaymentsFilePaymentIdPaymentDetails(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getFilePaymentsFilePaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *filePaymentId = filePaymentId_example; // FilePaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Get Payment Details
[apiInstance getFilePaymentsFilePaymentIdPaymentDetailsWith:filePaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWritePaymentDetailsResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.PaymentDetailsApi()

var filePaymentId = filePaymentId_example; // {String} FilePaymentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFilePaymentsFilePaymentIdPaymentDetails(filePaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFilePaymentsFilePaymentIdPaymentDetailsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var filePaymentId = filePaymentId_example;  // String | FilePaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Payment Details
                OBWritePaymentDetailsResponse1 result = apiInstance.getFilePaymentsFilePaymentIdPaymentDetails(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.getFilePaymentsFilePaymentIdPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\PaymentDetailsApi();
$filePaymentId = filePaymentId_example; // String | FilePaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getFilePaymentsFilePaymentIdPaymentDetails($filePaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getFilePaymentsFilePaymentIdPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $filePaymentId = filePaymentId_example; # String | FilePaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getFilePaymentsFilePaymentIdPaymentDetails(filePaymentId => $filePaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->getFilePaymentsFilePaymentIdPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
filePaymentId = filePaymentId_example # String | FilePaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Payment Details
    api_response = api_instance.get_file_payments_file_payment_id_payment_details(filePaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->getFilePaymentsFilePaymentIdPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
FilePaymentId*
String
FilePaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Payment Details Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getInternationalPaymentsInternationalPaymentIdPaymentDetails

Get Payment Details


/international-payments/{InternationalPaymentId}/payment-details

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/international-payments/{InternationalPaymentId}/payment-details"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String internationalPaymentId = internationalPaymentId_example; // String | InternationalPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalPaymentsInternationalPaymentIdPaymentDetails(internationalPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getInternationalPaymentsInternationalPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String internationalPaymentId = internationalPaymentId_example; // String | InternationalPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalPaymentsInternationalPaymentIdPaymentDetails(internationalPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getInternationalPaymentsInternationalPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *internationalPaymentId = internationalPaymentId_example; // InternationalPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Get Payment Details
[apiInstance getInternationalPaymentsInternationalPaymentIdPaymentDetailsWith:internationalPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWritePaymentDetailsResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.PaymentDetailsApi()

var internationalPaymentId = internationalPaymentId_example; // {String} InternationalPaymentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalPaymentsInternationalPaymentIdPaymentDetails(internationalPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalPaymentsInternationalPaymentIdPaymentDetailsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var internationalPaymentId = internationalPaymentId_example;  // String | InternationalPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Payment Details
                OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalPaymentsInternationalPaymentIdPaymentDetails(internationalPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.getInternationalPaymentsInternationalPaymentIdPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\PaymentDetailsApi();
$internationalPaymentId = internationalPaymentId_example; // String | InternationalPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getInternationalPaymentsInternationalPaymentIdPaymentDetails($internationalPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getInternationalPaymentsInternationalPaymentIdPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $internationalPaymentId = internationalPaymentId_example; # String | InternationalPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getInternationalPaymentsInternationalPaymentIdPaymentDetails(internationalPaymentId => $internationalPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->getInternationalPaymentsInternationalPaymentIdPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
internationalPaymentId = internationalPaymentId_example # String | InternationalPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Payment Details
    api_response = api_instance.get_international_payments_international_payment_id_payment_details(internationalPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->getInternationalPaymentsInternationalPaymentIdPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
InternationalPaymentId*
String
InternationalPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Payment Details Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails

Get Payment Details


/international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String internationalScheduledPaymentId = internationalScheduledPaymentId_example; // String | InternationalScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails(internationalScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String internationalScheduledPaymentId = internationalScheduledPaymentId_example; // String | InternationalScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails(internationalScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *internationalScheduledPaymentId = internationalScheduledPaymentId_example; // InternationalScheduledPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Get Payment Details
[apiInstance getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetailsWith:internationalScheduledPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWritePaymentDetailsResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.PaymentDetailsApi()

var internationalScheduledPaymentId = internationalScheduledPaymentId_example; // {String} InternationalScheduledPaymentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails(internationalScheduledPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetailsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var internationalScheduledPaymentId = internationalScheduledPaymentId_example;  // String | InternationalScheduledPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Payment Details
                OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails(internationalScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\PaymentDetailsApi();
$internationalScheduledPaymentId = internationalScheduledPaymentId_example; // String | InternationalScheduledPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails($internationalScheduledPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $internationalScheduledPaymentId = internationalScheduledPaymentId_example; # String | InternationalScheduledPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails(internationalScheduledPaymentId => $internationalScheduledPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
internationalScheduledPaymentId = internationalScheduledPaymentId_example # String | InternationalScheduledPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Payment Details
    api_response = api_instance.get_international_scheduled_payments_international_scheduled_payment_id_payment_details(internationalScheduledPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
InternationalScheduledPaymentId*
String
InternationalScheduledPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Payment Details Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails

Get Payment Details


/international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // String | InternationalStandingOrderPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails(internationalStandingOrderPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // String | InternationalStandingOrderPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails(internationalStandingOrderPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // InternationalStandingOrderPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Get Payment Details
[apiInstance getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetailsWith:internationalStandingOrderPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBWritePaymentDetailsResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.PaymentDetailsApi()

var internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // {String} InternationalStandingOrderPaymentId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails(internationalStandingOrderPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetailsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example;  // String | InternationalStandingOrderPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Payment Details
                OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails(internationalStandingOrderPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\PaymentDetailsApi();
$internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // String | InternationalStandingOrderPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails($internationalStandingOrderPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; # String | InternationalStandingOrderPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails(internationalStandingOrderPaymentId => $internationalStandingOrderPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example # String | InternationalStandingOrderPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Payment Details
    api_response = api_instance.get_international_standing_orders_international_standing_order_payment_id_payment_details(internationalStandingOrderPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
InternationalStandingOrderPaymentId*
String
InternationalStandingOrderPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Payment Details Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Products

getAccountsAccountIdProduct

Get Products


/accounts/{AccountId}/product

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/accounts/{AccountId}/product"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadProduct2 result = apiInstance.getAccountsAccountIdProduct(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getAccountsAccountIdProduct");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadProduct2 result = apiInstance.getAccountsAccountIdProduct(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getAccountsAccountIdProduct");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Get Products
[apiInstance getAccountsAccountIdProductWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadProduct2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.ProductsApi()

var accountId = accountId_example; // {String} AccountId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdProduct(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdProductExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Products
                OBReadProduct2 result = apiInstance.getAccountsAccountIdProduct(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getAccountsAccountIdProduct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\ProductsApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getAccountsAccountIdProduct($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getAccountsAccountIdProduct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getAccountsAccountIdProduct(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getAccountsAccountIdProduct: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Products
    api_response = api_instance.get_accounts_account_id_product(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getAccountsAccountIdProduct: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Products Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getProducts

Get Products


/products

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/products"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadProduct2 result = apiInstance.getProducts(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProducts");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadProduct2 result = apiInstance.getProducts(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProducts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Get Products
[apiInstance getProductsWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadProduct2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.ProductsApi()

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProducts(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProductsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Products
                OBReadProduct2 result = apiInstance.getProducts(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\ProductsApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getProducts($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getProducts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getProducts(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getProducts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Products
    api_response = api_instance.get_products(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getProducts: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Products Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

SME

unsecuredSmeLoansGet

Gets a list of all `Unsercured SME Lending` objects.


/unsecured-sme-loans

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/unsecured-sme-loans"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.SMEApi;

import java.io.File;
import java.util.*;

public class SMEApiExample {

    public static void main(String[] args) {
        
        SMEApi apiInstance = new SMEApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            UnsecuredSMELendingResponse result = apiInstance.unsecuredSmeLoansGet(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SMEApi#unsecuredSmeLoansGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.SMEApi;

public class SMEApiExample {

    public static void main(String[] args) {
        SMEApi apiInstance = new SMEApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            UnsecuredSMELendingResponse result = apiInstance.unsecuredSmeLoansGet(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SMEApi#unsecuredSmeLoansGet");
            e.printStackTrace();
        }
    }
}
String *ifModifiedSince = ifModifiedSince_example; // Used for conditional request, to retrieve data only if modified since a given date (optional)
String *ifNoneMatch = ifNoneMatch_example; // Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

SMEApi *apiInstance = [[SMEApi alloc] init];

[apiInstance unsecuredSmeLoansGetWith:ifModifiedSince
    ifNoneMatch:ifNoneMatch
              completionHandler: ^(UnsecuredSMELendingResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');

var api = new OpenBankingApi.SMEApi()

var opts = { 
  'ifModifiedSince': ifModifiedSince_example, // {String} Used for conditional request, to retrieve data only if modified since a given date
  'ifNoneMatch': ifNoneMatch_example // {String} Used for conditional request, to retrieve data only if the given Etag value does not match
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unsecuredSmeLoansGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class unsecuredSmeLoansGetExample
    {
        public void main()
        {
            
            var apiInstance = new SMEApi();
            var ifModifiedSince = ifModifiedSince_example;  // String | Used for conditional request, to retrieve data only if modified since a given date (optional) 
            var ifNoneMatch = ifNoneMatch_example;  // String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional) 

            try
            {
                UnsecuredSMELendingResponse result = apiInstance.unsecuredSmeLoansGet(ifModifiedSince, ifNoneMatch);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMEApi.unsecuredSmeLoansGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SMEApi();
$ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
$ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match

try {
    $result = $api_instance->unsecuredSmeLoansGet($ifModifiedSince, $ifNoneMatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMEApi->unsecuredSmeLoansGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SMEApi;

my $api_instance = WWW::SwaggerClient::SMEApi->new();
my $ifModifiedSince = ifModifiedSince_example; # String | Used for conditional request, to retrieve data only if modified since a given date
my $ifNoneMatch = ifNoneMatch_example; # String | Used for conditional request, to retrieve data only if the given Etag value does not match

eval { 
    my $result = $api_instance->unsecuredSmeLoansGet(ifModifiedSince => $ifModifiedSince, ifNoneMatch => $ifNoneMatch);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SMEApi->unsecuredSmeLoansGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SMEApi()
ifModifiedSince = ifModifiedSince_example # String | Used for conditional request, to retrieve data only if modified since a given date (optional)
ifNoneMatch = ifNoneMatch_example # String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

try: 
    api_response = api_instance.unsecured_sme_loans_get(ifModifiedSince=ifModifiedSince, ifNoneMatch=ifNoneMatch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SMEApi->unsecuredSmeLoansGet: %s\n" % e)

Parameters

Header parameters
Name Description
If-Modified-Since
String
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
String
Used for conditional request, to retrieve data only if the given Etag value does not match

Responses

Status: 200 - Successful response with a list of `Unsecured SME Lending` data

Name Type Format Description
Cache-Control String Describes how long this response can be cached
Etag String A unique ID identifying whether this resource has changed
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 400 - You have sent a request which could not be understood.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 408 - Your client has failed to submit a request, and a timeout has occurred.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 429 - You have requested this resource too often. Slow down.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 500 - An error occurred on the server. No further information is available.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: 503 - The service is temporarily unavailable.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

Status: default - A standard error response.

Name Type Format Description
Status Code Integer The HTTP status code defining the error
Strict-Transport-Security String HTTPS strict transport security header
X-Content-Type-Options String Ensures each page has a content type and prevents browsers from doing MIME type sniffing
X-Frame-Options String Prevent this request from being loaded in any iframes

unsecuredSmeLoansHead

Gets header information on the current set of `Unsercured SME Lending` data


/unsecured-sme-loans

Usage and SDK Samples

curl -X HEAD "https://localhost:8080/open-banking/v2.3/unsecured-sme-loans"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.SMEApi;

import java.io.File;
import java.util.*;

public class SMEApiExample {

    public static void main(String[] args) {
        
        SMEApi apiInstance = new SMEApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            Object result = apiInstance.unsecuredSmeLoansHead(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SMEApi#unsecuredSmeLoansHead");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.SMEApi;

public class SMEApiExample {

    public static void main(String[] args) {
        SMEApi apiInstance = new SMEApi();
        String ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
        String ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match
        try {
            Object result = apiInstance.unsecuredSmeLoansHead(ifModifiedSince, ifNoneMatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SMEApi#unsecuredSmeLoansHead");
            e.printStackTrace();
        }
    }
}
String *ifModifiedSince = ifModifiedSince_example; // Used for conditional request, to retrieve data only if modified since a given date (optional)
String *ifNoneMatch = ifNoneMatch_example; // Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

SMEApi *apiInstance = [[SMEApi alloc] init];

[apiInstance unsecuredSmeLoansHeadWith:ifModifiedSince
    ifNoneMatch:ifNoneMatch
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');

var api = new OpenBankingApi.SMEApi()

var opts = { 
  'ifModifiedSince': ifModifiedSince_example, // {String} Used for conditional request, to retrieve data only if modified since a given date
  'ifNoneMatch': ifNoneMatch_example // {String} Used for conditional request, to retrieve data only if the given Etag value does not match
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unsecuredSmeLoansHead(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class unsecuredSmeLoansHeadExample
    {
        public void main()
        {
            
            var apiInstance = new SMEApi();
            var ifModifiedSince = ifModifiedSince_example;  // String | Used for conditional request, to retrieve data only if modified since a given date (optional) 
            var ifNoneMatch = ifNoneMatch_example;  // String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional) 

            try
            {
                Object result = apiInstance.unsecuredSmeLoansHead(ifModifiedSince, ifNoneMatch);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMEApi.unsecuredSmeLoansHead: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SMEApi();
$ifModifiedSince = ifModifiedSince_example; // String | Used for conditional request, to retrieve data only if modified since a given date
$ifNoneMatch = ifNoneMatch_example; // String | Used for conditional request, to retrieve data only if the given Etag value does not match

try {
    $result = $api_instance->unsecuredSmeLoansHead($ifModifiedSince, $ifNoneMatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMEApi->unsecuredSmeLoansHead: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SMEApi;

my $api_instance = WWW::SwaggerClient::SMEApi->new();
my $ifModifiedSince = ifModifiedSince_example; # String | Used for conditional request, to retrieve data only if modified since a given date
my $ifNoneMatch = ifNoneMatch_example; # String | Used for conditional request, to retrieve data only if the given Etag value does not match

eval { 
    my $result = $api_instance->unsecuredSmeLoansHead(ifModifiedSince => $ifModifiedSince, ifNoneMatch => $ifNoneMatch);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SMEApi->unsecuredSmeLoansHead: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SMEApi()
ifModifiedSince = ifModifiedSince_example # String | Used for conditional request, to retrieve data only if modified since a given date (optional)
ifNoneMatch = ifNoneMatch_example # String | Used for conditional request, to retrieve data only if the given Etag value does not match (optional)

try: 
    api_response = api_instance.unsecured_sme_loans_head(ifModifiedSince=ifModifiedSince, ifNoneMatch=ifNoneMatch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SMEApi->unsecuredSmeLoansHead: %s\n" % e)

Parameters

Header parameters
Name Description
If-Modified-Since
String
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
String
Used for conditional request, to retrieve data only if the given Etag value does not match

Responses

Status: default - No response


ScheduledPayments

getAccountsAccountIdScheduledPayments

Get Scheduled Payments


/accounts/{AccountId}/scheduled-payments

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/accounts/{AccountId}/scheduled-payments"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.ScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class ScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        ScheduledPaymentsApi apiInstance = new ScheduledPaymentsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadScheduledPayment2 result = apiInstance.getAccountsAccountIdScheduledPayments(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduledPaymentsApi#getAccountsAccountIdScheduledPayments");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.ScheduledPaymentsApi;

public class ScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ScheduledPaymentsApi apiInstance = new ScheduledPaymentsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadScheduledPayment2 result = apiInstance.getAccountsAccountIdScheduledPayments(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduledPaymentsApi#getAccountsAccountIdScheduledPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

ScheduledPaymentsApi *apiInstance = [[ScheduledPaymentsApi alloc] init];

// Get Scheduled Payments
[apiInstance getAccountsAccountIdScheduledPaymentsWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadScheduledPayment2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.ScheduledPaymentsApi()

var accountId = accountId_example; // {String} AccountId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdScheduledPayments(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdScheduledPaymentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScheduledPaymentsApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Scheduled Payments
                OBReadScheduledPayment2 result = apiInstance.getAccountsAccountIdScheduledPayments(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScheduledPaymentsApi.getAccountsAccountIdScheduledPayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\ScheduledPaymentsApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getAccountsAccountIdScheduledPayments($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledPaymentsApi->getAccountsAccountIdScheduledPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScheduledPaymentsApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getAccountsAccountIdScheduledPayments(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScheduledPaymentsApi->getAccountsAccountIdScheduledPayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScheduledPaymentsApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Scheduled Payments
    api_response = api_instance.get_accounts_account_id_scheduled_payments(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScheduledPaymentsApi->getAccountsAccountIdScheduledPayments: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Scheduled Payments Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getScheduledPayments

Get Scheduled Payments


/scheduled-payments

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/scheduled-payments"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.ScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class ScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        ScheduledPaymentsApi apiInstance = new ScheduledPaymentsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadScheduledPayment2 result = apiInstance.getScheduledPayments(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduledPaymentsApi#getScheduledPayments");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.ScheduledPaymentsApi;

public class ScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ScheduledPaymentsApi apiInstance = new ScheduledPaymentsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadScheduledPayment2 result = apiInstance.getScheduledPayments(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduledPaymentsApi#getScheduledPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

ScheduledPaymentsApi *apiInstance = [[ScheduledPaymentsApi alloc] init];

// Get Scheduled Payments
[apiInstance getScheduledPaymentsWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadScheduledPayment2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.ScheduledPaymentsApi()

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getScheduledPayments(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getScheduledPaymentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ScheduledPaymentsApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Scheduled Payments
                OBReadScheduledPayment2 result = apiInstance.getScheduledPayments(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScheduledPaymentsApi.getScheduledPayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\ScheduledPaymentsApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getScheduledPayments($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledPaymentsApi->getScheduledPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ScheduledPaymentsApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getScheduledPayments(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScheduledPaymentsApi->getScheduledPayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ScheduledPaymentsApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Scheduled Payments
    api_response = api_instance.get_scheduled_payments(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScheduledPaymentsApi->getScheduledPayments: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Scheduled Payments Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

SoftwareStatementAssertions

organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdSoftwareStatementAssertionGet

Get a Software Statement Assertion for the given SoftwareStatementID.

The response body is a signed JWT and the values found in the header and the payload of the SSA are specified below # Terminology This specification uses the terms "access token", "authorization code", "authorization endpoint", "authorization grant", "authorization server", "client", "client identifier", "client secret", "grant type", "protected resource", "redirection URI", "refresh token", "resource owner", "resource server", "response type", and "token endpoint" defined by OAuth 2.0 [RFC6749] and uses the term "Claim" defined by JSON Web Token (JWT) [RFC7519]. * __Account Servicing Payment Services Provider (ASPSP)__ -- An organisation managing customer accounts (and operating banking APIs). * __Primary Technical Contact__ -- The person at the TPP who creates an SSA and invokes a registration mechanism. This is an example of an [RFC7591] Client Developer. * __OB Organisation ID__ -- The unique identifier for each OpenBanking participant. Both TPPs and ASPSPs have OB Organisation IDs. * __OpenBanking Directory__ -- An implementation of a [PSD2] competent authority; acts as an Identity Provider, certificate authority, and registry governing the participants in the UK OpenBanking API scheme. * __ASPSP Registration Endpoint__ -- OAuth 2.0 & [RFC7591] compliant endpoint, exact value is discoverable from the [OIDCD] openid-configuration file of the ASPSP. * __Software Statement Assertion (SSA)__ -- An implementation of an [RFC7591] software statement, signed by the OpenBanking Directory. * __Trusted Third Party (TPP)__ -- An organization working to initiate payments or consume account information with/from an ASPSP. * __TPP Client Software__ -- software implementing an OAuth2 client, interacting with an ASPSP registration endpoint. # Software Statement Assertion (SSA) The SSA is a JSON Web Token (JWT) containing client metadata about an instance of TPP client software. The JWT is issued and signed by the OpenBanking Directory. ## SSA Payload The payload of an OpenBanking SSA MUST be a compliant software statement according to [RFC7591]. The SSA MUST also be a compliant JWT according to [RFC7519]. The following metadata profiles the metadata in [RFC7591] and [RFC7519]: | Metadata | Description | Source Specification | |----------|-------------|----------------------| |`software_id`|Unique Identifier for TPP Client Software|[RFC7591]| |`iss`|SSA Issuer|[RFC7519]| |`iat`|Time SSA issued|[RFC7519]| |`jti`|JWT ID|[RFC7519]| The following software metadata is additionally defined for this profile: |Metadata |Description |Field Size |Default values | |---------|------------|-----------|---------------| |`software_client_id`|The Client ID Registered at OB used to access OB resources|Base62 GUID (22 chars)| | |`software_client_description`|Human-readable detailed description of the client|Max256Text| | |`software_client_name`|Human-readable Software Name|Max40Text| | |`software_client_uri`|The website or resource root uri|Max256Text| | |`software_version`|The version number of the software should a TPP choose to register and / or maintain it|decimal| | |`software_environment`|Requested additional field to avoid certificate check|Max256Text| | |`software_jwks_endpoint`|Contains all active signing and network certs for the software|Max256Text| | |`software_jwks_revoked_endpoint`|Contains all revoked signing and network certs for the software|Max256Text| | |`software_logo_uri`|Link to the TPP logo. Note, ASPSPs are not obliged to display images hosted by third parties|Max256Text| | |`software_mode`|ASPSP Requested additional field to indicate that this software is `Test` or `Live` the default is `Live`. Impact and support for `Test` software is up to the ASPSP.|Max40Text| | |`software_on_behalf_of_org`|A reference to fourth party organsiation resource on the OB Directory if the registering TPP is acting on behalf of another.|Max40Text| | |`software_policy_uri`|A link to the software's policy page|Max256Text| | |`software_redirect_uris`|Registered client callback endpoints as registered with Open Banking|A string array of Max256Text items| |`software_roles`|A multi value list of PSD2 roles that this software is authorized to perform.|A string array of Max256Text items| | |`software_tos_uri`|A link to the software's terms of service page|Max256Text| | The following Organisational metadata is defined for this profile: |Metadata |Description |Field Size | Default values | |---------|------------|-----------|----------------| |`organisation_competent_authority_claims`|Authorisations granted to the organsiation by an NCA|CodeList {`AISP`, `PISP`, `CBPII`, `ASPSP`}| | |`org_status`|Included to cater for voluntary withdrawal from OB scenarios|`Active`, `Revoked`, or `Withdrawn`| | |`org_id`|The Unique TPP or ASPSP ID held by OpenBanking.|Max35Text| | |`org_name`|Legal Entity Identifier or other known organisation name|Max140Text| | |`org_contacts`|JSON array of objects containing a triplet of name, email, and phone number|Each item Max256Text| | |`org_jwks_endpoint`|Contains all active signing and network certs for the organisation|Max256Text| | |`org_jwks_revoked_endpoint`|Contains all revoked signing and network certs for the organisation|Max256Text| | ## SSA header The SSA header MUST comply with [RFC7519]. |Metadata |Description |Comments | |---------|------------|---------| |`typ`|MUST be set to `JWT`| | |`alg`|MUST be set to `ES256` or `PS256`| | |`kid`|The kid will be kept the same as the `x5t` parameter. (X.509 Certificate SHA-1 Thumbprint) of the signing certificate.| | ### Example SSA The elements defined in the software statement will consist of the following values. *Note that there are inconsistent applications of booleans or "Active" strings in the current data model.* *Note that there are inconsistent applications of status flags case sensitivity.* *The attributes required to be displayed by ASPSPs.* ``` { "typ": "JWT", "alg": "ES256", "kid": "ABCD1234" } { "iss": "OpenBanking Ltd", "iat": 1492756331, "jti": "id12345685439487678", "software_environment": "production", "software_mode": "live", "software_id": "65d1f27c-4aea-4549-9c21-60e495a7a86f", "software_client_id": "OpenBanking TPP Client Unique ID", "software_client_name": "Amazon Prime Movies", "software_client_description": "Amazon Prime Movies is a moving streaming service", "software_version": "2.2", "software_client_uri": "https://prime.amazon.com", "software_redirect_uris": [ "https://prime.amazon.com/cb", "https://prime.amazon.co.uk/cb" ], "software_roles": [ "PISP", "AISP" ], "organisation_competent_authority_claims": { "authority_id": "FMA", // Austrian Financial Market Authority "registration_id": "111111", "status": "Active", "authorisations": [ { "member_state": "GB", "roles": [ "PISP", "AISP" ] }, { "member_state": "IR", "roles": [ "PISP" ] } ] }, "software_logo_uri": "https://prime.amazon.com/logo.png", "org_status": "Active", "org_id": "Amazon TPPID", "org_name": "OpenBanking TPP Registered Name", "org_contacts": [ { "name": "contact name", "email": "contact@contact.com", "phone": "+447890130558" "type": "business" }, { "name": "contact name", "email": "contact@contact.com", "phone": "+447890130558", "type": "technical" } ], "org_jwks_endpoint": "https://jwks.openbanking.org.uk/org_id/org_id.jkws", "org_jwks_revoked_endpoint": "https://jwks.openbanking.org.uk/org_id/revoked/org_id.jkws", "software_jwks_endpoint": "https://jwks.openbanking.org.uk/org_id/software_id.jkws", "software_jwks_revoked_endpoint": "https://jwks.openbanking.org.uk/org_id/revoked/software_id.jkws", "software_policy_uri": "https://tpp.com/policy.html", "software_tos_uri": "https://tpp.com/tos.html", "software_on_behalf_of_org": "Acme Ltd" } { Signature } ``` # Automated Client Registration A TPP MAY use automated client registration to submit an SSA to an ASPSP in exchange for client credentials for use as a client against an OAuth 2.0 Authorization Server. It is RECOMMENDED for ASPSPs to support the automated client registration mechanism. A large number of claims that OpenID Connect OPs could support as part of the RFC7591 request are detailed [https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata) and should be followed if not explicitly referenced in the Software Statement Assertion claim set. ## Request Validation Prior to issuing a client registration response, the ASPSP MUST perform the following checks * The ASPSP SHOULD check whether the TPP that initiated the TLS connection is the same TPP as listed in the SSA. * In the case where a gateway or other piece of infrastructure pre-terminates the MATLS channel in front of the registration endpoint, the certificate used to initiate the connection or some part of that certificate (such as DN & Issuer) SHOULD be made available to the ASPSP for validation against the claims in the SSA. * The registration request MUST be signed with a key contained in the JWKS referenced in the SSA included with the request. This ensures that a holder-of-key proof-of-possession is performed proving that the TPP app was the originally intended recipient of the SSA when the OB issued it. * The SSA MUST be validated according to [RFC7519], including validation of the signature and validity window. JWT signature must be validated, this involves retrieving the jwks keyset for both the OB and the TPP. The OB keystore location will be published as part of the directory specification, The TPP's will be included in the software statement. ### SSA Lifetime The SSA's Lifetime / Validity period is not defined by Open Banking. ASPSPs in the Open Banking ecosystem are required to implement pragmatic time ranges in which to accept an SSA. For example, an ASPSP that has implemented Dynamic Client Registration may choose to accept SSA's that were issued no earlier than 1 minute prior to their presentation however ASPSPs that only support manual registration may need to accept SSAs that were issued 30 minutes prior as the elapsed time period between generation and use between these two flows is expected to differ significantly.


/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}/software-statement-assertion

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}/software-statement-assertion"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.SoftwareStatementAssertionsApi;

import java.io.File;
import java.util.*;

public class SoftwareStatementAssertionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
        OAuth OAuth2SecurityReadOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadOps");
        OAuth2SecurityReadOps.setAccessToken("YOUR ACCESS TOKEN");

        SoftwareStatementAssertionsApi apiInstance = new SoftwareStatementAssertionsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdSoftwareStatementAssertionGet(organisationType, organisationId, softwareStatementId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementAssertionsApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdSoftwareStatementAssertionGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.SoftwareStatementAssertionsApi;

public class SoftwareStatementAssertionsApiExample {

    public static void main(String[] args) {
        SoftwareStatementAssertionsApi apiInstance = new SoftwareStatementAssertionsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdSoftwareStatementAssertionGet(organisationType, organisationId, softwareStatementId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementAssertionsApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdSoftwareStatementAssertionGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *softwareStatementId = softwareStatementId_example; // The software statement ID

SoftwareStatementAssertionsApi *apiInstance = [[SoftwareStatementAssertionsApi alloc] init];

// Get a Software Statement Assertion for the given SoftwareStatementID.
[apiInstance organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdSoftwareStatementAssertionGetWith:organisationType
    organisationId:organisationId
    softwareStatementId:softwareStatementId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
var OAuth2SecurityReadOps = defaultClient.authentications['OAuth2SecurityReadOps'];
OAuth2SecurityReadOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.SoftwareStatementAssertionsApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var softwareStatementId = softwareStatementId_example; // {String} The software statement ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdSoftwareStatementAssertionGet(organisationType, organisationId, softwareStatementId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdSoftwareStatementAssertionGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SoftwareStatementAssertionsApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var softwareStatementId = softwareStatementId_example;  // String | The software statement ID

            try
            {
                // Get a Software Statement Assertion for the given SoftwareStatementID.
                apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdSoftwareStatementAssertionGet(organisationType, organisationId, softwareStatementId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SoftwareStatementAssertionsApi.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdSoftwareStatementAssertionGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\SoftwareStatementAssertionsApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$softwareStatementId = softwareStatementId_example; // String | The software statement ID

try {
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdSoftwareStatementAssertionGet($organisationType, $organisationId, $softwareStatementId);
} catch (Exception $e) {
    echo 'Exception when calling SoftwareStatementAssertionsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdSoftwareStatementAssertionGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SoftwareStatementAssertionsApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SoftwareStatementAssertionsApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $softwareStatementId = softwareStatementId_example; # String | The software statement ID

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdSoftwareStatementAssertionGet(organisationType => $organisationType, organisationId => $organisationId, softwareStatementId => $softwareStatementId);
};
if ($@) {
    warn "Exception when calling SoftwareStatementAssertionsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdSoftwareStatementAssertionGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SoftwareStatementAssertionsApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
softwareStatementId = softwareStatementId_example # String | The software statement ID

try: 
    # Get a Software Statement Assertion for the given SoftwareStatementID.
    api_instance.organisation_organisation_type_organisation_id_software_statement_software_statement_id_software_statement_assertion_get(organisationType, organisationId, softwareStatementId)
except ApiException as e:
    print("Exception when calling SoftwareStatementAssertionsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdSoftwareStatementAssertionGet: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
SoftwareStatementId*
String
The software statement ID
Required

Responses

Status: 200 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

SoftwareStatementCertificates

organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateGet

Get certificates for the given software statement


/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}/certificate

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}/certificate"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.SoftwareStatementCertificatesApi;

import java.io.File;
import java.util.*;

public class SoftwareStatementCertificatesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
        OAuth OAuth2SecurityReadOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadOps");
        OAuth2SecurityReadOps.setAccessToken("YOUR ACCESS TOKEN");

        SoftwareStatementCertificatesApi apiInstance = new SoftwareStatementCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateGet(organisationType, organisationId, softwareStatementId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementCertificatesApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.SoftwareStatementCertificatesApi;

public class SoftwareStatementCertificatesApiExample {

    public static void main(String[] args) {
        SoftwareStatementCertificatesApi apiInstance = new SoftwareStatementCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateGet(organisationType, organisationId, softwareStatementId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementCertificatesApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *softwareStatementId = softwareStatementId_example; // The software statement ID

SoftwareStatementCertificatesApi *apiInstance = [[SoftwareStatementCertificatesApi alloc] init];

// Get certificates for the given software statement
[apiInstance organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateGetWith:organisationType
    organisationId:organisationId
    softwareStatementId:softwareStatementId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
var OAuth2SecurityReadOps = defaultClient.authentications['OAuth2SecurityReadOps'];
OAuth2SecurityReadOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.SoftwareStatementCertificatesApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var softwareStatementId = softwareStatementId_example; // {String} The software statement ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateGet(organisationType, organisationId, softwareStatementId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SoftwareStatementCertificatesApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var softwareStatementId = softwareStatementId_example;  // String | The software statement ID

            try
            {
                // Get certificates for the given software statement
                apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateGet(organisationType, organisationId, softwareStatementId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SoftwareStatementCertificatesApi.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\SoftwareStatementCertificatesApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$softwareStatementId = softwareStatementId_example; // String | The software statement ID

try {
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateGet($organisationType, $organisationId, $softwareStatementId);
} catch (Exception $e) {
    echo 'Exception when calling SoftwareStatementCertificatesApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SoftwareStatementCertificatesApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SoftwareStatementCertificatesApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $softwareStatementId = softwareStatementId_example; # String | The software statement ID

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateGet(organisationType => $organisationType, organisationId => $organisationId, softwareStatementId => $softwareStatementId);
};
if ($@) {
    warn "Exception when calling SoftwareStatementCertificatesApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SoftwareStatementCertificatesApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
softwareStatementId = softwareStatementId_example # String | The software statement ID

try: 
    # Get certificates for the given software statement
    api_instance.organisation_organisation_type_organisation_id_software_statement_software_statement_id_certificate_get(organisationType, organisationId, softwareStatementId)
except ApiException as e:
    print("Exception when calling SoftwareStatementCertificatesApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateGet: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
SoftwareStatementId*
String
The software statement ID
Required

Responses

Status: 200 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdGet

Get the certificate of the given type and ID for the given software statement


/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}/certificate/{OrganisationAssociativeCertificateType}/{CertificateOrKeyId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}/certificate/{OrganisationAssociativeCertificateType}/{CertificateOrKeyId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.SoftwareStatementCertificatesApi;

import java.io.File;
import java.util.*;

public class SoftwareStatementCertificatesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
        OAuth OAuth2SecurityReadOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadOps");
        OAuth2SecurityReadOps.setAccessToken("YOUR ACCESS TOKEN");

        SoftwareStatementCertificatesApi apiInstance = new SoftwareStatementCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        String organisationAssociativeCertificateType = organisationAssociativeCertificateType_example; // String | The certificate type that can be associated with a software statement
        String certificateOrKeyId = certificateOrKeyId_example; // String | The certificate or key Id
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdGet(organisationType, organisationId, softwareStatementId, organisationAssociativeCertificateType, certificateOrKeyId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementCertificatesApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.SoftwareStatementCertificatesApi;

public class SoftwareStatementCertificatesApiExample {

    public static void main(String[] args) {
        SoftwareStatementCertificatesApi apiInstance = new SoftwareStatementCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        String organisationAssociativeCertificateType = organisationAssociativeCertificateType_example; // String | The certificate type that can be associated with a software statement
        String certificateOrKeyId = certificateOrKeyId_example; // String | The certificate or key Id
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdGet(organisationType, organisationId, softwareStatementId, organisationAssociativeCertificateType, certificateOrKeyId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementCertificatesApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *softwareStatementId = softwareStatementId_example; // The software statement ID
String *organisationAssociativeCertificateType = organisationAssociativeCertificateType_example; // The certificate type that can be associated with a software statement
String *certificateOrKeyId = certificateOrKeyId_example; // The certificate or key Id

SoftwareStatementCertificatesApi *apiInstance = [[SoftwareStatementCertificatesApi alloc] init];

// Get the certificate of the given type and ID for the given software statement
[apiInstance organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdGetWith:organisationType
    organisationId:organisationId
    softwareStatementId:softwareStatementId
    organisationAssociativeCertificateType:organisationAssociativeCertificateType
    certificateOrKeyId:certificateOrKeyId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
var OAuth2SecurityReadOps = defaultClient.authentications['OAuth2SecurityReadOps'];
OAuth2SecurityReadOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.SoftwareStatementCertificatesApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var softwareStatementId = softwareStatementId_example; // {String} The software statement ID

var organisationAssociativeCertificateType = organisationAssociativeCertificateType_example; // {String} The certificate type that can be associated with a software statement

var certificateOrKeyId = certificateOrKeyId_example; // {String} The certificate or key Id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdGet(organisationType, organisationId, softwareStatementIdorganisationAssociativeCertificateType, certificateOrKeyId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SoftwareStatementCertificatesApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var softwareStatementId = softwareStatementId_example;  // String | The software statement ID
            var organisationAssociativeCertificateType = organisationAssociativeCertificateType_example;  // String | The certificate type that can be associated with a software statement
            var certificateOrKeyId = certificateOrKeyId_example;  // String | The certificate or key Id

            try
            {
                // Get the certificate of the given type and ID for the given software statement
                apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdGet(organisationType, organisationId, softwareStatementId, organisationAssociativeCertificateType, certificateOrKeyId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SoftwareStatementCertificatesApi.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\SoftwareStatementCertificatesApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$softwareStatementId = softwareStatementId_example; // String | The software statement ID
$organisationAssociativeCertificateType = organisationAssociativeCertificateType_example; // String | The certificate type that can be associated with a software statement
$certificateOrKeyId = certificateOrKeyId_example; // String | The certificate or key Id

try {
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdGet($organisationType, $organisationId, $softwareStatementId, $organisationAssociativeCertificateType, $certificateOrKeyId);
} catch (Exception $e) {
    echo 'Exception when calling SoftwareStatementCertificatesApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SoftwareStatementCertificatesApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SoftwareStatementCertificatesApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $softwareStatementId = softwareStatementId_example; # String | The software statement ID
my $organisationAssociativeCertificateType = organisationAssociativeCertificateType_example; # String | The certificate type that can be associated with a software statement
my $certificateOrKeyId = certificateOrKeyId_example; # String | The certificate or key Id

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdGet(organisationType => $organisationType, organisationId => $organisationId, softwareStatementId => $softwareStatementId, organisationAssociativeCertificateType => $organisationAssociativeCertificateType, certificateOrKeyId => $certificateOrKeyId);
};
if ($@) {
    warn "Exception when calling SoftwareStatementCertificatesApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SoftwareStatementCertificatesApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
softwareStatementId = softwareStatementId_example # String | The software statement ID
organisationAssociativeCertificateType = organisationAssociativeCertificateType_example # String | The certificate type that can be associated with a software statement
certificateOrKeyId = certificateOrKeyId_example # String | The certificate or key Id

try: 
    # Get the certificate of the given type and ID for the given software statement
    api_instance.organisation_organisation_type_organisation_id_software_statement_software_statement_id_certificate_organisation_associative_certificate_type_certificate_or_key_id_get(organisationType, organisationId, softwareStatementId, organisationAssociativeCertificateType, certificateOrKeyId)
except ApiException as e:
    print("Exception when calling SoftwareStatementCertificatesApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateOrganisationAssociativeCertificateTypeCertificateOrKeyIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
SoftwareStatementId*
String
The software statement ID
Required
OrganisationAssociativeCertificateType*
String
The certificate type that can be associated with a software statement
Required
CertificateOrKeyId*
String
The certificate or key Id
Required

Responses

Status: 200 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypeGet

Get the certificates of the given type for the given software statement


/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}/certificate/{SoftwareStatementCertificateOrKeyType}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}/certificate/{SoftwareStatementCertificateOrKeyType}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.SoftwareStatementCertificatesApi;

import java.io.File;
import java.util.*;

public class SoftwareStatementCertificatesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
        OAuth OAuth2SecurityReadOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadOps");
        OAuth2SecurityReadOps.setAccessToken("YOUR ACCESS TOKEN");

        SoftwareStatementCertificatesApi apiInstance = new SoftwareStatementCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        String softwareStatementCertificateOrKeyType = softwareStatementCertificateOrKeyType_example; // String | The certificate or key type that can be associated with a software statement
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypeGet(organisationType, organisationId, softwareStatementId, softwareStatementCertificateOrKeyType);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementCertificatesApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypeGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.SoftwareStatementCertificatesApi;

public class SoftwareStatementCertificatesApiExample {

    public static void main(String[] args) {
        SoftwareStatementCertificatesApi apiInstance = new SoftwareStatementCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        String softwareStatementCertificateOrKeyType = softwareStatementCertificateOrKeyType_example; // String | The certificate or key type that can be associated with a software statement
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypeGet(organisationType, organisationId, softwareStatementId, softwareStatementCertificateOrKeyType);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementCertificatesApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypeGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *softwareStatementId = softwareStatementId_example; // The software statement ID
String *softwareStatementCertificateOrKeyType = softwareStatementCertificateOrKeyType_example; // The certificate or key type that can be associated with a software statement

SoftwareStatementCertificatesApi *apiInstance = [[SoftwareStatementCertificatesApi alloc] init];

// Get the certificates of the given type for the given software statement
[apiInstance organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypeGetWith:organisationType
    organisationId:organisationId
    softwareStatementId:softwareStatementId
    softwareStatementCertificateOrKeyType:softwareStatementCertificateOrKeyType
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
var OAuth2SecurityReadOps = defaultClient.authentications['OAuth2SecurityReadOps'];
OAuth2SecurityReadOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.SoftwareStatementCertificatesApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var softwareStatementId = softwareStatementId_example; // {String} The software statement ID

var softwareStatementCertificateOrKeyType = softwareStatementCertificateOrKeyType_example; // {String} The certificate or key type that can be associated with a software statement


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypeGet(organisationType, organisationId, softwareStatementIdsoftwareStatementCertificateOrKeyType, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypeGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SoftwareStatementCertificatesApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var softwareStatementId = softwareStatementId_example;  // String | The software statement ID
            var softwareStatementCertificateOrKeyType = softwareStatementCertificateOrKeyType_example;  // String | The certificate or key type that can be associated with a software statement

            try
            {
                // Get the certificates of the given type for the given software statement
                apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypeGet(organisationType, organisationId, softwareStatementId, softwareStatementCertificateOrKeyType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SoftwareStatementCertificatesApi.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\SoftwareStatementCertificatesApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$softwareStatementId = softwareStatementId_example; // String | The software statement ID
$softwareStatementCertificateOrKeyType = softwareStatementCertificateOrKeyType_example; // String | The certificate or key type that can be associated with a software statement

try {
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypeGet($organisationType, $organisationId, $softwareStatementId, $softwareStatementCertificateOrKeyType);
} catch (Exception $e) {
    echo 'Exception when calling SoftwareStatementCertificatesApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypeGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SoftwareStatementCertificatesApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SoftwareStatementCertificatesApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $softwareStatementId = softwareStatementId_example; # String | The software statement ID
my $softwareStatementCertificateOrKeyType = softwareStatementCertificateOrKeyType_example; # String | The certificate or key type that can be associated with a software statement

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypeGet(organisationType => $organisationType, organisationId => $organisationId, softwareStatementId => $softwareStatementId, softwareStatementCertificateOrKeyType => $softwareStatementCertificateOrKeyType);
};
if ($@) {
    warn "Exception when calling SoftwareStatementCertificatesApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypeGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SoftwareStatementCertificatesApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
softwareStatementId = softwareStatementId_example # String | The software statement ID
softwareStatementCertificateOrKeyType = softwareStatementCertificateOrKeyType_example # String | The certificate or key type that can be associated with a software statement

try: 
    # Get the certificates of the given type for the given software statement
    api_instance.organisation_organisation_type_organisation_id_software_statement_software_statement_id_certificate_software_statement_certificate_or_key_type_get(organisationType, organisationId, softwareStatementId, softwareStatementCertificateOrKeyType)
except ApiException as e:
    print("Exception when calling SoftwareStatementCertificatesApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypeGet: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
SoftwareStatementId*
String
The software statement ID
Required
SoftwareStatementCertificateOrKeyType*
String
The certificate or key type that can be associated with a software statement
Required

Responses

Status: 200 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypePost

Add a key or create a new certificate for the given software statement


/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}/certificate/{SoftwareStatementCertificateOrKeyType}

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}/certificate/{SoftwareStatementCertificateOrKeyType}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.SoftwareStatementCertificatesApi;

import java.io.File;
import java.util.*;

public class SoftwareStatementCertificatesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
        OAuth OAuth2SecurityReadWriteOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadWriteOps");
        OAuth2SecurityReadWriteOps.setAccessToken("YOUR ACCESS TOKEN");

        SoftwareStatementCertificatesApi apiInstance = new SoftwareStatementCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        String softwareStatementCertificateOrKeyType = softwareStatementCertificateOrKeyType_example; // String | The certificate or key type that can be associated with a software statement
        CertificateOrKeyGetSchema cSROrKey = ; // CertificateOrKeyGetSchema | PEM file -- the contents of the PEM file will differ depending upon *SoftwareStatementCertificateOrKeyType*. If *SoftwareStatementCertificateOrKeyType* is set to *obsigning* or *obtransport* then the PEM file should contain a Certificate Signing Request (CSR) for an OB signing or OB transport certificate respectively; if *SoftwareStatementCertificateOrKeyType* is set to *sigkey*, *enckey* then the PEM file should contain a public signing or encryption key respectively.
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypePost(organisationType, organisationId, softwareStatementId, softwareStatementCertificateOrKeyType, cSROrKey);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementCertificatesApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypePost");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.SoftwareStatementCertificatesApi;

public class SoftwareStatementCertificatesApiExample {

    public static void main(String[] args) {
        SoftwareStatementCertificatesApi apiInstance = new SoftwareStatementCertificatesApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        String softwareStatementCertificateOrKeyType = softwareStatementCertificateOrKeyType_example; // String | The certificate or key type that can be associated with a software statement
        CertificateOrKeyGetSchema cSROrKey = ; // CertificateOrKeyGetSchema | PEM file -- the contents of the PEM file will differ depending upon *SoftwareStatementCertificateOrKeyType*. If *SoftwareStatementCertificateOrKeyType* is set to *obsigning* or *obtransport* then the PEM file should contain a Certificate Signing Request (CSR) for an OB signing or OB transport certificate respectively; if *SoftwareStatementCertificateOrKeyType* is set to *sigkey*, *enckey* then the PEM file should contain a public signing or encryption key respectively.
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypePost(organisationType, organisationId, softwareStatementId, softwareStatementCertificateOrKeyType, cSROrKey);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementCertificatesApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadWriteOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *softwareStatementId = softwareStatementId_example; // The software statement ID
String *softwareStatementCertificateOrKeyType = softwareStatementCertificateOrKeyType_example; // The certificate or key type that can be associated with a software statement
CertificateOrKeyGetSchema *cSROrKey = ; // PEM file -- the contents of the PEM file will differ depending upon *SoftwareStatementCertificateOrKeyType*. If *SoftwareStatementCertificateOrKeyType* is set to *obsigning* or *obtransport* then the PEM file should contain a Certificate Signing Request (CSR) for an OB signing or OB transport certificate respectively; if *SoftwareStatementCertificateOrKeyType* is set to *sigkey*, *enckey* then the PEM file should contain a public signing or encryption key respectively.

SoftwareStatementCertificatesApi *apiInstance = [[SoftwareStatementCertificatesApi alloc] init];

// Add a key or create a new certificate for the given software statement
[apiInstance organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypePostWith:organisationType
    organisationId:organisationId
    softwareStatementId:softwareStatementId
    softwareStatementCertificateOrKeyType:softwareStatementCertificateOrKeyType
    cSROrKey:cSROrKey
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
var OAuth2SecurityReadWriteOps = defaultClient.authentications['OAuth2SecurityReadWriteOps'];
OAuth2SecurityReadWriteOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.SoftwareStatementCertificatesApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var softwareStatementId = softwareStatementId_example; // {String} The software statement ID

var softwareStatementCertificateOrKeyType = softwareStatementCertificateOrKeyType_example; // {String} The certificate or key type that can be associated with a software statement

var cSROrKey = ; // {CertificateOrKeyGetSchema} PEM file -- the contents of the PEM file will differ depending upon *SoftwareStatementCertificateOrKeyType*. If *SoftwareStatementCertificateOrKeyType* is set to *obsigning* or *obtransport* then the PEM file should contain a Certificate Signing Request (CSR) for an OB signing or OB transport certificate respectively; if *SoftwareStatementCertificateOrKeyType* is set to *sigkey*, *enckey* then the PEM file should contain a public signing or encryption key respectively.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypePost(organisationType, organisationId, softwareStatementIdsoftwareStatementCertificateOrKeyType, cSROrKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypePostExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SoftwareStatementCertificatesApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var softwareStatementId = softwareStatementId_example;  // String | The software statement ID
            var softwareStatementCertificateOrKeyType = softwareStatementCertificateOrKeyType_example;  // String | The certificate or key type that can be associated with a software statement
            var cSROrKey = new CertificateOrKeyGetSchema(); // CertificateOrKeyGetSchema | PEM file -- the contents of the PEM file will differ depending upon *SoftwareStatementCertificateOrKeyType*. If *SoftwareStatementCertificateOrKeyType* is set to *obsigning* or *obtransport* then the PEM file should contain a Certificate Signing Request (CSR) for an OB signing or OB transport certificate respectively; if *SoftwareStatementCertificateOrKeyType* is set to *sigkey*, *enckey* then the PEM file should contain a public signing or encryption key respectively.

            try
            {
                // Add a key or create a new certificate for the given software statement
                apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypePost(organisationType, organisationId, softwareStatementId, softwareStatementCertificateOrKeyType, cSROrKey);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SoftwareStatementCertificatesApi.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\SoftwareStatementCertificatesApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$softwareStatementId = softwareStatementId_example; // String | The software statement ID
$softwareStatementCertificateOrKeyType = softwareStatementCertificateOrKeyType_example; // String | The certificate or key type that can be associated with a software statement
$cSROrKey = ; // CertificateOrKeyGetSchema | PEM file -- the contents of the PEM file will differ depending upon *SoftwareStatementCertificateOrKeyType*. If *SoftwareStatementCertificateOrKeyType* is set to *obsigning* or *obtransport* then the PEM file should contain a Certificate Signing Request (CSR) for an OB signing or OB transport certificate respectively; if *SoftwareStatementCertificateOrKeyType* is set to *sigkey*, *enckey* then the PEM file should contain a public signing or encryption key respectively.

try {
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypePost($organisationType, $organisationId, $softwareStatementId, $softwareStatementCertificateOrKeyType, $cSROrKey);
} catch (Exception $e) {
    echo 'Exception when calling SoftwareStatementCertificatesApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SoftwareStatementCertificatesApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SoftwareStatementCertificatesApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $softwareStatementId = softwareStatementId_example; # String | The software statement ID
my $softwareStatementCertificateOrKeyType = softwareStatementCertificateOrKeyType_example; # String | The certificate or key type that can be associated with a software statement
my $cSROrKey = WWW::SwaggerClient::Object::CertificateOrKeyGetSchema->new(); # CertificateOrKeyGetSchema | PEM file -- the contents of the PEM file will differ depending upon *SoftwareStatementCertificateOrKeyType*. If *SoftwareStatementCertificateOrKeyType* is set to *obsigning* or *obtransport* then the PEM file should contain a Certificate Signing Request (CSR) for an OB signing or OB transport certificate respectively; if *SoftwareStatementCertificateOrKeyType* is set to *sigkey*, *enckey* then the PEM file should contain a public signing or encryption key respectively.

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypePost(organisationType => $organisationType, organisationId => $organisationId, softwareStatementId => $softwareStatementId, softwareStatementCertificateOrKeyType => $softwareStatementCertificateOrKeyType, cSROrKey => $cSROrKey);
};
if ($@) {
    warn "Exception when calling SoftwareStatementCertificatesApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SoftwareStatementCertificatesApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
softwareStatementId = softwareStatementId_example # String | The software statement ID
softwareStatementCertificateOrKeyType = softwareStatementCertificateOrKeyType_example # String | The certificate or key type that can be associated with a software statement
cSROrKey =  # CertificateOrKeyGetSchema | PEM file -- the contents of the PEM file will differ depending upon *SoftwareStatementCertificateOrKeyType*. If *SoftwareStatementCertificateOrKeyType* is set to *obsigning* or *obtransport* then the PEM file should contain a Certificate Signing Request (CSR) for an OB signing or OB transport certificate respectively; if *SoftwareStatementCertificateOrKeyType* is set to *sigkey*, *enckey* then the PEM file should contain a public signing or encryption key respectively.

try: 
    # Add a key or create a new certificate for the given software statement
    api_instance.organisation_organisation_type_organisation_id_software_statement_software_statement_id_certificate_software_statement_certificate_or_key_type_post(organisationType, organisationId, softwareStatementId, softwareStatementCertificateOrKeyType, cSROrKey)
except ApiException as e:
    print("Exception when calling SoftwareStatementCertificatesApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdCertificateSoftwareStatementCertificateOrKeyTypePost: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
SoftwareStatementId*
String
The software statement ID
Required
SoftwareStatementCertificateOrKeyType*
String
The certificate or key type that can be associated with a software statement
Required
Body parameters
Name Description
cSROrKey *

Responses

Status: 201 - Created

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

SoftwareStatementRedirectURIs

organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdRedirectUriPost

Add a redirect URI to the given Software Statement


/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}/redirect-uri

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}/redirect-uri"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.SoftwareStatementRedirectURIsApi;

import java.io.File;
import java.util.*;

public class SoftwareStatementRedirectURIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
        OAuth OAuth2SecurityReadWriteOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadWriteOps");
        OAuth2SecurityReadWriteOps.setAccessToken("YOUR ACCESS TOKEN");

        SoftwareStatementRedirectURIsApi apiInstance = new SoftwareStatementRedirectURIsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        SoftwareStatementRedirectURISchema softwareStatementRedirectURI = ; // SoftwareStatementRedirectURISchema | Software Statement Redirect URI
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdRedirectUriPost(organisationType, organisationId, softwareStatementId, softwareStatementRedirectURI);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementRedirectURIsApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdRedirectUriPost");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.SoftwareStatementRedirectURIsApi;

public class SoftwareStatementRedirectURIsApiExample {

    public static void main(String[] args) {
        SoftwareStatementRedirectURIsApi apiInstance = new SoftwareStatementRedirectURIsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        SoftwareStatementRedirectURISchema softwareStatementRedirectURI = ; // SoftwareStatementRedirectURISchema | Software Statement Redirect URI
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdRedirectUriPost(organisationType, organisationId, softwareStatementId, softwareStatementRedirectURI);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementRedirectURIsApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdRedirectUriPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadWriteOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *softwareStatementId = softwareStatementId_example; // The software statement ID
SoftwareStatementRedirectURISchema *softwareStatementRedirectURI = ; // Software Statement Redirect URI

SoftwareStatementRedirectURIsApi *apiInstance = [[SoftwareStatementRedirectURIsApi alloc] init];

// Add a redirect URI to the given Software Statement
[apiInstance organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdRedirectUriPostWith:organisationType
    organisationId:organisationId
    softwareStatementId:softwareStatementId
    softwareStatementRedirectURI:softwareStatementRedirectURI
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
var OAuth2SecurityReadWriteOps = defaultClient.authentications['OAuth2SecurityReadWriteOps'];
OAuth2SecurityReadWriteOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.SoftwareStatementRedirectURIsApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var softwareStatementId = softwareStatementId_example; // {String} The software statement ID

var softwareStatementRedirectURI = ; // {SoftwareStatementRedirectURISchema} Software Statement Redirect URI


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdRedirectUriPost(organisationType, organisationId, softwareStatementIdsoftwareStatementRedirectURI, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdRedirectUriPostExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SoftwareStatementRedirectURIsApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var softwareStatementId = softwareStatementId_example;  // String | The software statement ID
            var softwareStatementRedirectURI = new SoftwareStatementRedirectURISchema(); // SoftwareStatementRedirectURISchema | Software Statement Redirect URI

            try
            {
                // Add a redirect URI to the given Software Statement
                apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdRedirectUriPost(organisationType, organisationId, softwareStatementId, softwareStatementRedirectURI);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SoftwareStatementRedirectURIsApi.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdRedirectUriPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\SoftwareStatementRedirectURIsApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$softwareStatementId = softwareStatementId_example; // String | The software statement ID
$softwareStatementRedirectURI = ; // SoftwareStatementRedirectURISchema | Software Statement Redirect URI

try {
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdRedirectUriPost($organisationType, $organisationId, $softwareStatementId, $softwareStatementRedirectURI);
} catch (Exception $e) {
    echo 'Exception when calling SoftwareStatementRedirectURIsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdRedirectUriPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SoftwareStatementRedirectURIsApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SoftwareStatementRedirectURIsApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $softwareStatementId = softwareStatementId_example; # String | The software statement ID
my $softwareStatementRedirectURI = WWW::SwaggerClient::Object::SoftwareStatementRedirectURISchema->new(); # SoftwareStatementRedirectURISchema | Software Statement Redirect URI

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdRedirectUriPost(organisationType => $organisationType, organisationId => $organisationId, softwareStatementId => $softwareStatementId, softwareStatementRedirectURI => $softwareStatementRedirectURI);
};
if ($@) {
    warn "Exception when calling SoftwareStatementRedirectURIsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdRedirectUriPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SoftwareStatementRedirectURIsApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
softwareStatementId = softwareStatementId_example # String | The software statement ID
softwareStatementRedirectURI =  # SoftwareStatementRedirectURISchema | Software Statement Redirect URI

try: 
    # Add a redirect URI to the given Software Statement
    api_instance.organisation_organisation_type_organisation_id_software_statement_software_statement_id_redirect_uri_post(organisationType, organisationId, softwareStatementId, softwareStatementRedirectURI)
except ApiException as e:
    print("Exception when calling SoftwareStatementRedirectURIsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdRedirectUriPost: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
SoftwareStatementId*
String
The software statement ID
Required
Body parameters
Name Description
softwareStatementRedirectURI *

Responses

Status: 200 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 409 - Conflict

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

SoftwareStatements

organisationOrganisationTypeOrganisationIdSoftwareStatementGet

Get all software statements for the given organisation


/organisation/{OrganisationType}/{OrganisationId}/software-statement

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/software-statement"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.SoftwareStatementsApi;

import java.io.File;
import java.util.*;

public class SoftwareStatementsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
        OAuth OAuth2SecurityReadOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadOps");
        OAuth2SecurityReadOps.setAccessToken("YOUR ACCESS TOKEN");

        SoftwareStatementsApi apiInstance = new SoftwareStatementsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementGet(organisationType, organisationId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementsApi#organisationOrganisationTypeOrganisationIdSoftwareStatementGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.SoftwareStatementsApi;

public class SoftwareStatementsApiExample {

    public static void main(String[] args) {
        SoftwareStatementsApi apiInstance = new SoftwareStatementsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementGet(organisationType, organisationId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementsApi#organisationOrganisationTypeOrganisationIdSoftwareStatementGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID

SoftwareStatementsApi *apiInstance = [[SoftwareStatementsApi alloc] init];

// Get all software statements for the given organisation
[apiInstance organisationOrganisationTypeOrganisationIdSoftwareStatementGetWith:organisationType
    organisationId:organisationId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
var OAuth2SecurityReadOps = defaultClient.authentications['OAuth2SecurityReadOps'];
OAuth2SecurityReadOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.SoftwareStatementsApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdSoftwareStatementGet(organisationType, organisationId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdSoftwareStatementGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SoftwareStatementsApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID

            try
            {
                // Get all software statements for the given organisation
                apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementGet(organisationType, organisationId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SoftwareStatementsApi.organisationOrganisationTypeOrganisationIdSoftwareStatementGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\SoftwareStatementsApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID

try {
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementGet($organisationType, $organisationId);
} catch (Exception $e) {
    echo 'Exception when calling SoftwareStatementsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SoftwareStatementsApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SoftwareStatementsApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementGet(organisationType => $organisationType, organisationId => $organisationId);
};
if ($@) {
    warn "Exception when calling SoftwareStatementsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SoftwareStatementsApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID

try: 
    # Get all software statements for the given organisation
    api_instance.organisation_organisation_type_organisation_id_software_statement_get(organisationType, organisationId)
except ApiException as e:
    print("Exception when calling SoftwareStatementsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementGet: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required

Responses

Status: 200 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypeOrganisationIdSoftwareStatementPost

Create a software statement


/organisation/{OrganisationType}/{OrganisationId}/software-statement

Usage and SDK Samples

curl -X POST "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/software-statement"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.SoftwareStatementsApi;

import java.io.File;
import java.util.*;

public class SoftwareStatementsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
        OAuth OAuth2SecurityReadWriteOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadWriteOps");
        OAuth2SecurityReadWriteOps.setAccessToken("YOUR ACCESS TOKEN");

        SoftwareStatementsApi apiInstance = new SoftwareStatementsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        SoftwareStatementCreateSchema softwareStatement = ; // SoftwareStatementCreateSchema | Software Statement payload
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementPost(organisationType, organisationId, softwareStatement);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementsApi#organisationOrganisationTypeOrganisationIdSoftwareStatementPost");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.SoftwareStatementsApi;

public class SoftwareStatementsApiExample {

    public static void main(String[] args) {
        SoftwareStatementsApi apiInstance = new SoftwareStatementsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        SoftwareStatementCreateSchema softwareStatement = ; // SoftwareStatementCreateSchema | Software Statement payload
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementPost(organisationType, organisationId, softwareStatement);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementsApi#organisationOrganisationTypeOrganisationIdSoftwareStatementPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadWriteOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
SoftwareStatementCreateSchema *softwareStatement = ; // Software Statement payload

SoftwareStatementsApi *apiInstance = [[SoftwareStatementsApi alloc] init];

// Create a software statement
[apiInstance organisationOrganisationTypeOrganisationIdSoftwareStatementPostWith:organisationType
    organisationId:organisationId
    softwareStatement:softwareStatement
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
var OAuth2SecurityReadWriteOps = defaultClient.authentications['OAuth2SecurityReadWriteOps'];
OAuth2SecurityReadWriteOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.SoftwareStatementsApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var softwareStatement = ; // {SoftwareStatementCreateSchema} Software Statement payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdSoftwareStatementPost(organisationType, organisationId, softwareStatement, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdSoftwareStatementPostExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SoftwareStatementsApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var softwareStatement = new SoftwareStatementCreateSchema(); // SoftwareStatementCreateSchema | Software Statement payload

            try
            {
                // Create a software statement
                apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementPost(organisationType, organisationId, softwareStatement);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SoftwareStatementsApi.organisationOrganisationTypeOrganisationIdSoftwareStatementPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\SoftwareStatementsApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$softwareStatement = ; // SoftwareStatementCreateSchema | Software Statement payload

try {
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementPost($organisationType, $organisationId, $softwareStatement);
} catch (Exception $e) {
    echo 'Exception when calling SoftwareStatementsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SoftwareStatementsApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SoftwareStatementsApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $softwareStatement = WWW::SwaggerClient::Object::SoftwareStatementCreateSchema->new(); # SoftwareStatementCreateSchema | Software Statement payload

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementPost(organisationType => $organisationType, organisationId => $organisationId, softwareStatement => $softwareStatement);
};
if ($@) {
    warn "Exception when calling SoftwareStatementsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SoftwareStatementsApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
softwareStatement =  # SoftwareStatementCreateSchema | Software Statement payload

try: 
    # Create a software statement
    api_instance.organisation_organisation_type_organisation_id_software_statement_post(organisationType, organisationId, softwareStatement)
except ApiException as e:
    print("Exception when calling SoftwareStatementsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementPost: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
Body parameters
Name Description
softwareStatement *

Responses

Status: 201 - Created

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdGet

Get a software statement


/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.SoftwareStatementsApi;

import java.io.File;
import java.util.*;

public class SoftwareStatementsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
        OAuth OAuth2SecurityReadOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadOps");
        OAuth2SecurityReadOps.setAccessToken("YOUR ACCESS TOKEN");

        SoftwareStatementsApi apiInstance = new SoftwareStatementsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdGet(organisationType, organisationId, softwareStatementId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementsApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdGet");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.SoftwareStatementsApi;

public class SoftwareStatementsApiExample {

    public static void main(String[] args) {
        SoftwareStatementsApi apiInstance = new SoftwareStatementsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdGet(organisationType, organisationId, softwareStatementId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementsApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *softwareStatementId = softwareStatementId_example; // The software statement ID

SoftwareStatementsApi *apiInstance = [[SoftwareStatementsApi alloc] init];

// Get a software statement
[apiInstance organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdGetWith:organisationType
    organisationId:organisationId
    softwareStatementId:softwareStatementId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
var OAuth2SecurityReadOps = defaultClient.authentications['OAuth2SecurityReadOps'];
OAuth2SecurityReadOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.SoftwareStatementsApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var softwareStatementId = softwareStatementId_example; // {String} The software statement ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdGet(organisationType, organisationId, softwareStatementId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdGetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SoftwareStatementsApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var softwareStatementId = softwareStatementId_example;  // String | The software statement ID

            try
            {
                // Get a software statement
                apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdGet(organisationType, organisationId, softwareStatementId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SoftwareStatementsApi.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\SoftwareStatementsApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$softwareStatementId = softwareStatementId_example; // String | The software statement ID

try {
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdGet($organisationType, $organisationId, $softwareStatementId);
} catch (Exception $e) {
    echo 'Exception when calling SoftwareStatementsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SoftwareStatementsApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SoftwareStatementsApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $softwareStatementId = softwareStatementId_example; # String | The software statement ID

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdGet(organisationType => $organisationType, organisationId => $organisationId, softwareStatementId => $softwareStatementId);
};
if ($@) {
    warn "Exception when calling SoftwareStatementsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SoftwareStatementsApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
softwareStatementId = softwareStatementId_example # String | The software statement ID

try: 
    # Get a software statement
    api_instance.organisation_organisation_type_organisation_id_software_statement_software_statement_id_get(organisationType, organisationId, softwareStatementId)
except ApiException as e:
    print("Exception when calling SoftwareStatementsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
SoftwareStatementId*
String
The software statement ID
Required

Responses

Status: 200 - Created

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdPut

Update a software statement


/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}

Usage and SDK Samples

curl -X PUT "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}/{OrganisationId}/software-statement/{SoftwareStatementId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.SoftwareStatementsApi;

import java.io.File;
import java.util.*;

public class SoftwareStatementsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
        OAuth OAuth2SecurityReadWriteOps = (OAuth) defaultClient.getAuthentication("OAuth2SecurityReadWriteOps");
        OAuth2SecurityReadWriteOps.setAccessToken("YOUR ACCESS TOKEN");

        SoftwareStatementsApi apiInstance = new SoftwareStatementsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        SoftwareStatementStateSchema softwareStatementState = ; // SoftwareStatementStateSchema | Payload used to deactivate/reactivate a Software Statement
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdPut(organisationType, organisationId, softwareStatementId, softwareStatementState);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementsApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdPut");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.SoftwareStatementsApi;

public class SoftwareStatementsApiExample {

    public static void main(String[] args) {
        SoftwareStatementsApi apiInstance = new SoftwareStatementsApi();
        String organisationType = organisationType_example; // String | OB Organisation Type
        String organisationId = organisationId_example; // String | The organsation ID
        String softwareStatementId = softwareStatementId_example; // String | The software statement ID
        SoftwareStatementStateSchema softwareStatementState = ; // SoftwareStatementStateSchema | Payload used to deactivate/reactivate a Software Statement
        try {
            apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdPut(organisationType, organisationId, softwareStatementId, softwareStatementState);
        } catch (ApiException e) {
            System.err.println("Exception when calling SoftwareStatementsApi#organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2SecurityReadWriteOps)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *organisationType = organisationType_example; // OB Organisation Type
String *organisationId = organisationId_example; // The organsation ID
String *softwareStatementId = softwareStatementId_example; // The software statement ID
SoftwareStatementStateSchema *softwareStatementState = ; // Payload used to deactivate/reactivate a Software Statement

SoftwareStatementsApi *apiInstance = [[SoftwareStatementsApi alloc] init];

// Update a software statement
[apiInstance organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdPutWith:organisationType
    organisationId:organisationId
    softwareStatementId:softwareStatementId
    softwareStatementState:softwareStatementState
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
var OAuth2SecurityReadWriteOps = defaultClient.authentications['OAuth2SecurityReadWriteOps'];
OAuth2SecurityReadWriteOps.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.SoftwareStatementsApi()

var organisationType = organisationType_example; // {String} OB Organisation Type

var organisationId = organisationId_example; // {String} The organsation ID

var softwareStatementId = softwareStatementId_example; // {String} The software statement ID

var softwareStatementState = ; // {SoftwareStatementStateSchema} Payload used to deactivate/reactivate a Software Statement


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdPut(organisationType, organisationId, softwareStatementIdsoftwareStatementState, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdPutExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SoftwareStatementsApi();
            var organisationType = organisationType_example;  // String | OB Organisation Type
            var organisationId = organisationId_example;  // String | The organsation ID
            var softwareStatementId = softwareStatementId_example;  // String | The software statement ID
            var softwareStatementState = new SoftwareStatementStateSchema(); // SoftwareStatementStateSchema | Payload used to deactivate/reactivate a Software Statement

            try
            {
                // Update a software statement
                apiInstance.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdPut(organisationType, organisationId, softwareStatementId, softwareStatementState);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SoftwareStatementsApi.organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\SoftwareStatementsApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationId = organisationId_example; // String | The organsation ID
$softwareStatementId = softwareStatementId_example; // String | The software statement ID
$softwareStatementState = ; // SoftwareStatementStateSchema | Payload used to deactivate/reactivate a Software Statement

try {
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdPut($organisationType, $organisationId, $softwareStatementId, $softwareStatementState);
} catch (Exception $e) {
    echo 'Exception when calling SoftwareStatementsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SoftwareStatementsApi;

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SoftwareStatementsApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationId = organisationId_example; # String | The organsation ID
my $softwareStatementId = softwareStatementId_example; # String | The software statement ID
my $softwareStatementState = WWW::SwaggerClient::Object::SoftwareStatementStateSchema->new(); # SoftwareStatementStateSchema | Payload used to deactivate/reactivate a Software Statement

eval { 
    $api_instance->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdPut(organisationType => $organisationType, organisationId => $organisationId, softwareStatementId => $softwareStatementId, softwareStatementState => $softwareStatementState);
};
if ($@) {
    warn "Exception when calling SoftwareStatementsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdPut: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2SecurityReadWriteOps
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SoftwareStatementsApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationId = organisationId_example # String | The organsation ID
softwareStatementId = softwareStatementId_example # String | The software statement ID
softwareStatementState =  # SoftwareStatementStateSchema | Payload used to deactivate/reactivate a Software Statement

try: 
    # Update a software statement
    api_instance.organisation_organisation_type_organisation_id_software_statement_software_statement_id_put(organisationType, organisationId, softwareStatementId, softwareStatementState)
except ApiException as e:
    print("Exception when calling SoftwareStatementsApi->organisationOrganisationTypeOrganisationIdSoftwareStatementSoftwareStatementIdPut: %s\n" % e)

Parameters

Path parameters
Name Description
OrganisationType*
String
OB Organisation Type
Required
OrganisationId*
String
The organsation ID
Required
SoftwareStatementId*
String
The software statement ID
Required
Body parameters
Name Description
softwareStatementState *

Responses

Status: 200 - OK

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 400 - Bad Request

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 401 - Unauthorized

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 404 - Not found

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 406 - Not Acceptable

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 500 - Internal Server Error

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

Status: 502 - Bad Gateway

Name Type Format Description
OB-Request-Id String Unique Request Id. Give it to the Support Desk if you eve need help with a request that does not work the way you expected.

StandingOrders

getAccountsAccountIdStandingOrders

Get Standing Orders


/accounts/{AccountId}/standing-orders

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/accounts/{AccountId}/standing-orders"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.StandingOrdersApi;

import java.io.File;
import java.util.*;

public class StandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        StandingOrdersApi apiInstance = new StandingOrdersApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadStandingOrder5 result = apiInstance.getAccountsAccountIdStandingOrders(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StandingOrdersApi#getAccountsAccountIdStandingOrders");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.StandingOrdersApi;

public class StandingOrdersApiExample {

    public static void main(String[] args) {
        StandingOrdersApi apiInstance = new StandingOrdersApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadStandingOrder5 result = apiInstance.getAccountsAccountIdStandingOrders(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StandingOrdersApi#getAccountsAccountIdStandingOrders");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

StandingOrdersApi *apiInstance = [[StandingOrdersApi alloc] init];

// Get Standing Orders
[apiInstance getAccountsAccountIdStandingOrdersWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadStandingOrder5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.StandingOrdersApi()

var accountId = accountId_example; // {String} AccountId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdStandingOrders(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdStandingOrdersExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StandingOrdersApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Standing Orders
                OBReadStandingOrder5 result = apiInstance.getAccountsAccountIdStandingOrders(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StandingOrdersApi.getAccountsAccountIdStandingOrders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\StandingOrdersApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getAccountsAccountIdStandingOrders($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StandingOrdersApi->getAccountsAccountIdStandingOrders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StandingOrdersApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StandingOrdersApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getAccountsAccountIdStandingOrders(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StandingOrdersApi->getAccountsAccountIdStandingOrders: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StandingOrdersApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Standing Orders
    api_response = api_instance.get_accounts_account_id_standing_orders(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StandingOrdersApi->getAccountsAccountIdStandingOrders: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Standing Orders Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getStandingOrders

Get Standing Orders


/standing-orders

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/standing-orders"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.StandingOrdersApi;

import java.io.File;
import java.util.*;

public class StandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        StandingOrdersApi apiInstance = new StandingOrdersApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadStandingOrder5 result = apiInstance.getStandingOrders(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StandingOrdersApi#getStandingOrders");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.StandingOrdersApi;

public class StandingOrdersApiExample {

    public static void main(String[] args) {
        StandingOrdersApi apiInstance = new StandingOrdersApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadStandingOrder5 result = apiInstance.getStandingOrders(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StandingOrdersApi#getStandingOrders");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

StandingOrdersApi *apiInstance = [[StandingOrdersApi alloc] init];

// Get Standing Orders
[apiInstance getStandingOrdersWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadStandingOrder5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.StandingOrdersApi()

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStandingOrders(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getStandingOrdersExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StandingOrdersApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Standing Orders
                OBReadStandingOrder5 result = apiInstance.getStandingOrders(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StandingOrdersApi.getStandingOrders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\StandingOrdersApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getStandingOrders($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StandingOrdersApi->getStandingOrders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StandingOrdersApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StandingOrdersApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getStandingOrders(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StandingOrdersApi->getStandingOrders: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StandingOrdersApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Standing Orders
    api_response = api_instance.get_standing_orders(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StandingOrdersApi->getStandingOrders: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Standing Orders Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Statements

getAccountsAccountIdStatements

Get Statements


/accounts/{AccountId}/statements

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/accounts/{AccountId}/statements?fromStatementDateTime=&toStatementDateTime="
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.StatementsApi;

import java.io.File;
import java.util.*;

public class StatementsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        StatementsApi apiInstance = new StatementsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        Date fromStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        Date toStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        try {
            OBReadStatement2 result = apiInstance.getAccountsAccountIdStatements(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, fromStatementDateTime, toStatementDateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getAccountsAccountIdStatements");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.StatementsApi;

public class StatementsApiExample {

    public static void main(String[] args) {
        StatementsApi apiInstance = new StatementsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        Date fromStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        Date toStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        try {
            OBReadStatement2 result = apiInstance.getAccountsAccountIdStatements(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, fromStatementDateTime, toStatementDateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getAccountsAccountIdStatements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
Date *fromStatementDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
Date *toStatementDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)

StatementsApi *apiInstance = [[StatementsApi alloc] init];

// Get Statements
[apiInstance getAccountsAccountIdStatementsWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    fromStatementDateTime:fromStatementDateTime
    toStatementDateTime:toStatementDateTime
              completionHandler: ^(OBReadStatement2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.StatementsApi()

var accountId = accountId_example; // {String} AccountId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
  'fromStatementDateTime': 2013-10-20T19:20:30+01:00, // {Date} The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
  'toStatementDateTime': 2013-10-20T19:20:30+01:00 // {Date} The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdStatements(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdStatementsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StatementsApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var fromStatementDateTime = 2013-10-20T19:20:30+01:00;  // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional) 
            var toStatementDateTime = 2013-10-20T19:20:30+01:00;  // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional) 

            try
            {
                // Get Statements
                OBReadStatement2 result = apiInstance.getAccountsAccountIdStatements(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, fromStatementDateTime, toStatementDateTime);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatementsApi.getAccountsAccountIdStatements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\StatementsApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$fromStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
$toStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

try {
    $result = $api_instance->getAccountsAccountIdStatements($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $fromStatementDateTime, $toStatementDateTime);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatementsApi->getAccountsAccountIdStatements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatementsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StatementsApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $fromStatementDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
my $toStatementDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

eval { 
    my $result = $api_instance->getAccountsAccountIdStatements(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, fromStatementDateTime => $fromStatementDateTime, toStatementDateTime => $toStatementDateTime);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatementsApi->getAccountsAccountIdStatements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StatementsApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
fromStatementDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
toStatementDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)

try: 
    # Get Statements
    api_response = api_instance.get_accounts_account_id_statements(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, fromStatementDateTime=fromStatementDateTime, toStatementDateTime=toStatementDateTime)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatementsApi->getAccountsAccountIdStatements: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
Query parameters
Name Description
fromStatementDateTime
Date (date-time)
The UTC ISO 8601 Date Time to filter statements FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
toStatementDateTime
Date (date-time)
The UTC ISO 8601 Date Time to filter statements TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

Responses

Status: 200 - Statements Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getAccountsAccountIdStatementsStatementId

Get Statements


/accounts/{AccountId}/statements/{StatementId}

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/accounts/{AccountId}/statements/{StatementId}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.StatementsApi;

import java.io.File;
import java.util.*;

public class StatementsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        StatementsApi apiInstance = new StatementsApi();
        String statementId = statementId_example; // String | StatementId
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadStatement2 result = apiInstance.getAccountsAccountIdStatementsStatementId(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getAccountsAccountIdStatementsStatementId");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.StatementsApi;

public class StatementsApiExample {

    public static void main(String[] args) {
        StatementsApi apiInstance = new StatementsApi();
        String statementId = statementId_example; // String | StatementId
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadStatement2 result = apiInstance.getAccountsAccountIdStatementsStatementId(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getAccountsAccountIdStatementsStatementId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *statementId = statementId_example; // StatementId
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

StatementsApi *apiInstance = [[StatementsApi alloc] init];

// Get Statements
[apiInstance getAccountsAccountIdStatementsStatementIdWith:statementId
    accountId:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadStatement2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.StatementsApi()

var statementId = statementId_example; // {String} StatementId

var accountId = accountId_example; // {String} AccountId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdStatementsStatementId(statementId, accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdStatementsStatementIdExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StatementsApi();
            var statementId = statementId_example;  // String | StatementId
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Statements
                OBReadStatement2 result = apiInstance.getAccountsAccountIdStatementsStatementId(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatementsApi.getAccountsAccountIdStatementsStatementId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\StatementsApi();
$statementId = statementId_example; // String | StatementId
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getAccountsAccountIdStatementsStatementId($statementId, $accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatementsApi->getAccountsAccountIdStatementsStatementId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatementsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StatementsApi->new();
my $statementId = statementId_example; # String | StatementId
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getAccountsAccountIdStatementsStatementId(statementId => $statementId, accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatementsApi->getAccountsAccountIdStatementsStatementId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StatementsApi()
statementId = statementId_example # String | StatementId
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Statements
    api_response = api_instance.get_accounts_account_id_statements_statement_id(statementId, accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatementsApi->getAccountsAccountIdStatementsStatementId: %s\n" % e)

Parameters

Path parameters
Name Description
StatementId*
String
StatementId
Required
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Statements Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getAccountsAccountIdStatementsStatementIdFile

Get Statements


/accounts/{AccountId}/statements/{StatementId}/file

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/accounts/{AccountId}/statements/{StatementId}/file"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.StatementsApi;

import java.io.File;
import java.util.*;

public class StatementsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        StatementsApi apiInstance = new StatementsApi();
        String statementId = statementId_example; // String | StatementId
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            File result = apiInstance.getAccountsAccountIdStatementsStatementIdFile(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getAccountsAccountIdStatementsStatementIdFile");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.StatementsApi;

public class StatementsApiExample {

    public static void main(String[] args) {
        StatementsApi apiInstance = new StatementsApi();
        String statementId = statementId_example; // String | StatementId
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            File result = apiInstance.getAccountsAccountIdStatementsStatementIdFile(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getAccountsAccountIdStatementsStatementIdFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *statementId = statementId_example; // StatementId
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

StatementsApi *apiInstance = [[StatementsApi alloc] init];

// Get Statements
[apiInstance getAccountsAccountIdStatementsStatementIdFileWith:statementId
    accountId:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(File output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.StatementsApi()

var statementId = statementId_example; // {String} StatementId

var accountId = accountId_example; // {String} AccountId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdStatementsStatementIdFile(statementId, accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdStatementsStatementIdFileExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StatementsApi();
            var statementId = statementId_example;  // String | StatementId
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Statements
                File result = apiInstance.getAccountsAccountIdStatementsStatementIdFile(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatementsApi.getAccountsAccountIdStatementsStatementIdFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\StatementsApi();
$statementId = statementId_example; // String | StatementId
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getAccountsAccountIdStatementsStatementIdFile($statementId, $accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatementsApi->getAccountsAccountIdStatementsStatementIdFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatementsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StatementsApi->new();
my $statementId = statementId_example; # String | StatementId
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getAccountsAccountIdStatementsStatementIdFile(statementId => $statementId, accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatementsApi->getAccountsAccountIdStatementsStatementIdFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StatementsApi()
statementId = statementId_example # String | StatementId
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Statements
    api_response = api_instance.get_accounts_account_id_statements_statement_id_file(statementId, accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatementsApi->getAccountsAccountIdStatementsStatementIdFile: %s\n" % e)

Parameters

Path parameters
Name Description
StatementId*
String
StatementId
Required
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Statements Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getStatements

Get Statements


/statements

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/statements?fromStatementDateTime=&toStatementDateTime="
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.StatementsApi;

import java.io.File;
import java.util.*;

public class StatementsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        StatementsApi apiInstance = new StatementsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        Date fromStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        Date toStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        try {
            OBReadStatement2 result = apiInstance.getStatements(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, fromStatementDateTime, toStatementDateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getStatements");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.StatementsApi;

public class StatementsApiExample {

    public static void main(String[] args) {
        StatementsApi apiInstance = new StatementsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        Date fromStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        Date toStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        try {
            OBReadStatement2 result = apiInstance.getStatements(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, fromStatementDateTime, toStatementDateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getStatements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
Date *fromStatementDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
Date *toStatementDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)

StatementsApi *apiInstance = [[StatementsApi alloc] init];

// Get Statements
[apiInstance getStatementsWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    fromStatementDateTime:fromStatementDateTime
    toStatementDateTime:toStatementDateTime
              completionHandler: ^(OBReadStatement2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.StatementsApi()

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
  'fromStatementDateTime': 2013-10-20T19:20:30+01:00, // {Date} The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
  'toStatementDateTime': 2013-10-20T19:20:30+01:00 // {Date} The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStatements(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getStatementsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StatementsApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var fromStatementDateTime = 2013-10-20T19:20:30+01:00;  // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional) 
            var toStatementDateTime = 2013-10-20T19:20:30+01:00;  // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional) 

            try
            {
                // Get Statements
                OBReadStatement2 result = apiInstance.getStatements(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, fromStatementDateTime, toStatementDateTime);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatementsApi.getStatements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\StatementsApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$fromStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
$toStatementDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

try {
    $result = $api_instance->getStatements($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $fromStatementDateTime, $toStatementDateTime);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatementsApi->getStatements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatementsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StatementsApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $fromStatementDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
my $toStatementDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

eval { 
    my $result = $api_instance->getStatements(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, fromStatementDateTime => $fromStatementDateTime, toStatementDateTime => $toStatementDateTime);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatementsApi->getStatements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StatementsApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
fromStatementDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter statements FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
toStatementDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter statements TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)

try: 
    # Get Statements
    api_response = api_instance.get_statements(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, fromStatementDateTime=fromStatementDateTime, toStatementDateTime=toStatementDateTime)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatementsApi->getStatements: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
Query parameters
Name Description
fromStatementDateTime
Date (date-time)
The UTC ISO 8601 Date Time to filter statements FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
toStatementDateTime
Date (date-time)
The UTC ISO 8601 Date Time to filter statements TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

Responses

Status: 200 - Statements Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Transactions

getAccountsAccountIdStatementsStatementIdTransactions

Get Transactions


/accounts/{AccountId}/statements/{StatementId}/transactions

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/accounts/{AccountId}/statements/{StatementId}/transactions"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        TransactionsApi apiInstance = new TransactionsApi();
        String statementId = statementId_example; // String | StatementId
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadTransaction5 result = apiInstance.getAccountsAccountIdStatementsStatementIdTransactions(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getAccountsAccountIdStatementsStatementIdTransactions");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.TransactionsApi;

public class TransactionsApiExample {

    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String statementId = statementId_example; // String | StatementId
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        try {
            OBReadTransaction5 result = apiInstance.getAccountsAccountIdStatementsStatementIdTransactions(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getAccountsAccountIdStatementsStatementIdTransactions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *statementId = statementId_example; // StatementId
String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)

TransactionsApi *apiInstance = [[TransactionsApi alloc] init];

// Get Transactions
[apiInstance getAccountsAccountIdStatementsStatementIdTransactionsWith:statementId
    accountId:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
              completionHandler: ^(OBReadTransaction5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.TransactionsApi()

var statementId = statementId_example; // {String} StatementId

var accountId = accountId_example; // {String} AccountId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdStatementsStatementIdTransactions(statementId, accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdStatementsStatementIdTransactionsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransactionsApi();
            var statementId = statementId_example;  // String | StatementId
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 

            try
            {
                // Get Transactions
                OBReadTransaction5 result = apiInstance.getAccountsAccountIdStatementsStatementIdTransactions(statementId, accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionsApi.getAccountsAccountIdStatementsStatementIdTransactions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\TransactionsApi();
$statementId = statementId_example; // String | StatementId
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.

try {
    $result = $api_instance->getAccountsAccountIdStatementsStatementIdTransactions($statementId, $accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getAccountsAccountIdStatementsStatementIdTransactions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransactionsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransactionsApi->new();
my $statementId = statementId_example; # String | StatementId
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.

eval { 
    my $result = $api_instance->getAccountsAccountIdStatementsStatementIdTransactions(statementId => $statementId, accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getAccountsAccountIdStatementsStatementIdTransactions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransactionsApi()
statementId = statementId_example # String | StatementId
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)

try: 
    # Get Transactions
    api_response = api_instance.get_accounts_account_id_statements_statement_id_transactions(statementId, accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getAccountsAccountIdStatementsStatementIdTransactions: %s\n" % e)

Parameters

Path parameters
Name Description
StatementId*
String
StatementId
Required
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required

Responses

Status: 200 - Transactions Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getAccountsAccountIdTransactions

Get Transactions


/accounts/{AccountId}/transactions

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/accounts/{AccountId}/transactions?fromBookingDateTime=&toBookingDateTime="
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        TransactionsApi apiInstance = new TransactionsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        Date fromBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        Date toBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        try {
            OBReadTransaction5 result = apiInstance.getAccountsAccountIdTransactions(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, fromBookingDateTime, toBookingDateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getAccountsAccountIdTransactions");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.TransactionsApi;

public class TransactionsApiExample {

    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String accountId = accountId_example; // String | AccountId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        Date fromBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        Date toBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        try {
            OBReadTransaction5 result = apiInstance.getAccountsAccountIdTransactions(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, fromBookingDateTime, toBookingDateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getAccountsAccountIdTransactions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *accountId = accountId_example; // AccountId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
Date *fromBookingDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
Date *toBookingDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)

TransactionsApi *apiInstance = [[TransactionsApi alloc] init];

// Get Transactions
[apiInstance getAccountsAccountIdTransactionsWith:accountId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    fromBookingDateTime:fromBookingDateTime
    toBookingDateTime:toBookingDateTime
              completionHandler: ^(OBReadTransaction5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.TransactionsApi()

var accountId = accountId_example; // {String} AccountId

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
  'fromBookingDateTime': 2013-10-20T19:20:30+01:00, // {Date} The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
  'toBookingDateTime': 2013-10-20T19:20:30+01:00 // {Date} The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsAccountIdTransactions(accountId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsAccountIdTransactionsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransactionsApi();
            var accountId = accountId_example;  // String | AccountId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var fromBookingDateTime = 2013-10-20T19:20:30+01:00;  // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional) 
            var toBookingDateTime = 2013-10-20T19:20:30+01:00;  // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional) 

            try
            {
                // Get Transactions
                OBReadTransaction5 result = apiInstance.getAccountsAccountIdTransactions(accountId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, fromBookingDateTime, toBookingDateTime);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionsApi.getAccountsAccountIdTransactions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\TransactionsApi();
$accountId = accountId_example; // String | AccountId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$fromBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
$toBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

try {
    $result = $api_instance->getAccountsAccountIdTransactions($accountId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $fromBookingDateTime, $toBookingDateTime);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getAccountsAccountIdTransactions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransactionsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransactionsApi->new();
my $accountId = accountId_example; # String | AccountId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $fromBookingDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
my $toBookingDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

eval { 
    my $result = $api_instance->getAccountsAccountIdTransactions(accountId => $accountId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, fromBookingDateTime => $fromBookingDateTime, toBookingDateTime => $toBookingDateTime);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getAccountsAccountIdTransactions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransactionsApi()
accountId = accountId_example # String | AccountId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
fromBookingDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
toBookingDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)

try: 
    # Get Transactions
    api_response = api_instance.get_accounts_account_id_transactions(accountId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, fromBookingDateTime=fromBookingDateTime, toBookingDateTime=toBookingDateTime)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getAccountsAccountIdTransactions: %s\n" % e)

Parameters

Path parameters
Name Description
AccountId*
String
AccountId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
Query parameters
Name Description
fromBookingDateTime
Date (date-time)
The UTC ISO 8601 Date Time to filter transactions FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
toBookingDateTime
Date (date-time)
The UTC ISO 8601 Date Time to filter transactions TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

Responses

Status: 200 - Transactions Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

getTransactions

Get Transactions


/transactions

Usage and SDK Samples

curl -X GET "https://localhost:8080/open-banking/v2.3/transactions?fromBookingDateTime=&toBookingDateTime="
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        TransactionsApi apiInstance = new TransactionsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        Date fromBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        Date toBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        try {
            OBReadTransaction5 result = apiInstance.getTransactions(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, fromBookingDateTime, toBookingDateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getTransactions");
            e.printStackTrace();
        }
    }
}
import com.laegler.openbanking.api.TransactionsApi;

public class TransactionsApiExample {

    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        Date fromBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        Date toBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
        try {
            OBReadTransaction5 result = apiInstance.getTransactions(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, fromBookingDateTime, toBookingDateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getTransactions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
Date *fromBookingDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
Date *toBookingDateTime = 2013-10-20T19:20:30+01:00; // The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)

TransactionsApi *apiInstance = [[TransactionsApi alloc] init];

// Get Transactions
[apiInstance getTransactionsWith:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    fromBookingDateTime:fromBookingDateTime
    toBookingDateTime:toBookingDateTime
              completionHandler: ^(OBReadTransaction5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenBankingApi = require('open_banking_api');
var defaultClient = OpenBankingApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

var api = new OpenBankingApi.TransactionsApi()

var authorization = authorization_example; // {String} An Authorisation Token as per https://tools.ietf.org/html/rfc6750

var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {String} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {String} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {String} An RFC4122 UID used as a correlation id.
  'fromBookingDateTime': 2013-10-20T19:20:30+01:00, // {Date} The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
  'toBookingDateTime': 2013-10-20T19:20:30+01:00 // {Date} The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTransactions(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTransactionsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransactionsApi();
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var fromBookingDateTime = 2013-10-20T19:20:30+01:00;  // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional) 
            var toBookingDateTime = 2013-10-20T19:20:30+01:00;  // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional) 

            try
            {
                // Get Transactions
                OBReadTransaction5 result = apiInstance.getTransactions(authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, fromBookingDateTime, toBookingDateTime);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionsApi.getTransactions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\TransactionsApi();
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$fromBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
$toBookingDateTime = 2013-10-20T19:20:30+01:00; // Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

try {
    $result = $api_instance->getTransactions($authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $fromBookingDateTime, $toBookingDateTime);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getTransactions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransactionsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransactionsApi->new();
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $fromBookingDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
my $toBookingDateTime = 2013-10-20T19:20:30+01:00; # Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

eval { 
    my $result = $api_instance->getTransactions(authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, fromBookingDateTime => $fromBookingDateTime, toBookingDateTime => $toBookingDateTime);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getTransactions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransactionsApi()
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
fromBookingDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)
toBookingDateTime = 2013-10-20T19:20:30+01:00 # Date | The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component. (optional)

try: 
    # Get Transactions
    api_response = api_instance.get_transactions(authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, fromBookingDateTime=fromBookingDateTime, toBookingDateTime=toBookingDateTime)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getTransactions: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
Query parameters
Name Description
fromBookingDateTime
Date (date-time)
The UTC ISO 8601 Date Time to filter transactions FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
toBookingDateTime
Date (date-time)
The UTC ISO 8601 Date Time to filter transactions TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

Responses

Status: 200 - Transactions Read

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 401 - Unauthorized

Name Type Format Description
WWW-Authenticate String Response header field specified in https://tools.ietf.org/html/rfc6750
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer Number in seconds to wait
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String An RFC4122 UID used as a correlation id.
x-jws-signature String Header containing a detached JWS signature of the body of the payload.